Skip to content

Commit d958b68

Browse files
Gokul-KGGokul-KG
authored
Merge pull request #58 from Kranthi-Guribilli/docs
Update github workflows for wiki
2 parents f985af9 + cec1ceb commit d958b68

File tree

6 files changed

+180
-1
lines changed

6 files changed

+180
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: 🐞 Bug
3+
about: File a bug/issue
4+
title: '[BUG] <title>'
5+
labels: Bug
6+
assignees: ''
7+
8+
---
9+
10+
* To report vulnerabilities please refer [SECURITY.md](https://github.com/datakaveri/iudx-onboarding-server/blob/main/SECURITY.md)
11+
12+
### Current Behavior:
13+
<!-- A concise description of what you're experiencing. -->
14+
15+
### Expected Behavior:
16+
<!-- A concise description of what you expected to happen. -->
17+
18+
### Steps To Reproduce:
19+
<!--
20+
Example: steps to reproduce the behavior:
21+
1. In this environment...
22+
1. With this config...
23+
1. Run '...'
24+
1. See error...
25+
-->
26+
27+
### Screenshots or videos (optional)
28+
29+
### Environment:
30+
<!--
31+
Example:
32+
- OS: Ubuntu 20.04
33+
- Node: 13.14.0
34+
- npm: 7.6.3
35+
-->
36+
37+
### Anything else:
38+
<!--
39+
Links? References? Anything that will give us more context about the issue that you are encountering!
40+
-->

‎.github/ISSUE_TEMPLATE/new-feature.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: ✨ Feature
3+
about: a new feature request
4+
title: '[Feature] <title>'
5+
labels: feature
6+
assignees: ''
7+
8+
---
9+
10+
Thank you for filling out this feature request report :vulcan_salute:
11+
12+
13+
### Description:
14+
<!-- A concise and clear description of feature you're interested in. -->
15+
16+
### Suggestion:
17+
<!-- Describe a solution you'd like. A concise description of what you expected to happen. -->
18+
19+
### Alternatives:
20+
<!-- Describe the alternative solution or feature -->
21+
22+
### Anything else:
23+
<!--
24+
Links? References? Anything that will give us more context about the feature that is being requested!
25+
-->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
* Please refer to the code of conduct : [link](https://github.com/datakaveri/iudx-onboarding-server/blob/main/CODE_OF_CONDUCT.md)
2+
3+
* **Please check if the PR fulfills these requirements** :clipboard:
4+
- [ ] The commit message follows our guidelines : [link](https://github.com/datakaveri/iudx-onboarding-server/blob/main/CONTRIBUTING.md)
5+
- [ ] Tests for the changes have been added (for bug fixes/features)
6+
- [ ] Docs have been added/updated (for bug fixes/features)
7+
- [ ] A new branch is created for the change(s) and the changes are not committed on the main or master branch
8+
- [ ] No credentials or secrets are committed
9+
10+
* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, refactor, chore, test, config) :information_desk_person: :scroll:
11+
12+
Describe the changes <br>
13+
14+
* **Fixes** :wrench: # (issue)
15+
16+
* **Checklist for the current PR** :page_with_curl:
17+
- [ ] I have made corresponding changes to the documentation
18+
- [ ] I have added the respective changes in the [example-config](../example-config/config-dev.json)
19+
if the changes are made in [config](../secrets/all-verticles-configs/config-dev.json)
20+
- [ ] For the changes made in example-config, backend components (elasticsearch, flyway files for postgres, immudb schema, rabbitmq) I have notified DX DevOps team by mentioning [at-sign]datakaveri/devops as a PR comment to help facilitate the further necessary changes
21+
- [ ] I have mentioned the DX Catalogue items required in [resources-used](../src/test/resources/DX-Catalogue-Items/RESOURCES_USED.md)
22+
- [ ] I have commented on my code, particularly in hard-to-understand areas
23+
- [ ] My changes generate no new warnings
24+
- [ ] I have added tests that prove my fix is effective or that my feature works
25+
- [ ] New and existing unit tests pass locally with my changes
26+
- [ ] pmd, check style issues are resolved locally
27+
- [ ] I have added reviewers to check the proposed changes
28+
29+
* Please delete the content that is not relevant.

‎.github/workflows/update_wiki.yml ‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
name: Update Wiki
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches:
7+
- main
8+
pull_request:
9+
branches:
10+
- main
11+
jobs:
12+
update-wiki:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout Repository
16+
uses: actions/checkout@v3
17+
18+
- name: Set up Git
19+
run: |
20+
git config --global user.email "github-actions[bot]@users.noreply.github.com"
21+
git config --global user.name "github-actions[bot]"
22+
23+
- name: Clone Wiki Repository
24+
env:
25+
GITHUB_TOKEN: ${{ secrets.DOC_UPDATE }}
26+
run: |
27+
git clone https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.wiki.git wiki
28+
continue-on-error: true
29+
30+
- name: Remove Old Wiki Content
31+
run: |
32+
echo "Removing old wiki content.."
33+
rm -rf wiki/*
34+
35+
- name: Copy other files to target repository
36+
run: |
37+
cp -r LICENSE wiki/LICENSE.md |
38+
cp -r CODE_OF_CONDUCT.md wiki/ |
39+
cp -r CONTRIBUTING.md wiki/ |
40+
cp -r SECURITY.md wiki/ |
41+
ls -la wiki/
42+
43+
- name: Copy and Modify README for Wiki
44+
run: |
45+
echo "Copying and modifying README.md to wiki/Home.md..."
46+
sed -e 's|./docs/|./|g' \
47+
-e 's|./Solution_Architecture.md|./02-Solution-Architecture|g' \
48+
-e 's|./Configurations.md|./03-Configurations|g' \
49+
-e 's|./Explanation.md|./04-Explanation|g' \
50+
-e 's|./SETUP-and-Installation.md|./05-SETUP-and-Installation|g' \
51+
-e 's|./FAQ.md|07-FAQ|g' \
52+
-e 's|./mai./|d/main/docs/|g' README.md > wiki/Home.md
53+
ls -la wiki # Verify the file creation
54+
55+
- name: Copy Files to Wiki
56+
run: |
57+
echo "Copying files..."
58+
cp -r docs/* wiki/
59+
ls -la wiki # List files to verify copying
60+
61+
- name: Rename Files to Ensure Correct Order
62+
run: |
63+
echo "Renaming files to ensure correct order..."
64+
mv wiki/Solution_Architecture.md wiki/02-Solution-Architecture.md
65+
mv wiki/Configurations.md wiki/03-Configurations.md
66+
mv wiki/Explanation.md wiki/04-Explanation.md
67+
mv wiki/SETUP-and-Installation.md wiki/05-SETUP-and-Installation.md
68+
mv wiki/FAQ.md wiki/07-FAQ.md
69+
mv wiki/LICENSE.md wiki/08-License.md
70+
mv wiki/CODE_OF_CONDUCT.md wiki/09-Code-of-conduct.md | sed -i -e 's/.\/docs\/cdpg.png/cdpg.png/ ' wiki/09-Code-of-conduct.md
71+
mv wiki/CONTRIBUTING.md wiki/10-Contributing.md | sed -i -e 's/.\/docs\/cdpg.png/cdpg.png/ ' wiki/10-Contributing.md
72+
mv wiki/SECURITY.md wiki/11-Security.md | sed -i -e 's/.\/docs\/cdpg.png/cdpg.png/ ' wiki/11-Security.md
73+
ls -la wiki # List files to verify renaming
74+
75+
76+
- name: Commit and Push Changes to Wiki
77+
run: |
78+
cd wiki
79+
git add .
80+
git commit -m "Update wiki content with new file order" || echo "No changes to commit"
81+
git push
82+
continue-on-error: true
83+
84+
- name: List files in wiki directory after push
85+
run: ls -la wiki

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ metadata in a federated Catalogue server model.
3232

3333
# How to Guide
3434
## Setup and Installation
35-
Setup and installation guide is available [here](./docs/SETUP-and-installation.md)
35+
Setup and installation guide is available [here](./docs/SETUP-and-Installation)
3636

3737
# Reference
3838
## API Docs

docs/SETUP-and-installation.md renamed to docs/SETUP-and-Installation.md

File renamed without changes.

0 commit comments

Comments
 (0)