Merge pull request #84 from ICPSR/rde_documentation

RDE metadata documentation

Author: shallcro

.github/workflows/update_html.yaml

@@ -11,13 +11,14 @@ jobs:
   update_html:
     runs-on: ubuntu-latest
     name: Update HTML
+    if: github.event.pull_request.merged == true   # Only run if the PR was merged
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: 3.11
 
@@ -37,25 +38,24 @@ jobs:
 
   deploy:
     runs-on: ubuntu-latest
-    needs: update_html  # Specify that this job depends on the completion of 'update_html'
+    needs: update_html
     permissions:
       contents: read
       pages: write
       id-token: write
-    
+
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           ref: gh-pages
 
       - name: Setup Pages
-        uses: actions/configure-pages@v4
+        uses: actions/configure-pages@v5
 
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
+        uses: actions/upload-pages-artifact@v4
         with:
-          # Upload entire repository
           path: '.'
 
       - name: Deploy to GitHub Pages

.github/workflows/update_md.yaml

@@ -7,6 +7,8 @@ on:
       - gh-pages
     paths:
       - 'schema/**'
+      - 'rde_schema/**'
+      - 'markdown/**'
 
 jobs:
   update_markdown:
@@ -15,39 +17,61 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
-      - name: Get changed files in the schema folder
-        id: changed-schema-specific
-        uses: tj-actions/changed-files@v44
+      - name: Get changed files in schema folder
+        id: changed-schema
+        uses: tj-actions/changed-files@v47
         with:
           files: schema/**
 
-      - name: Prevent from running if no schema files changed
-        if: steps.changed-schema-specific.outputs.any_changed != 'true'
-        run: exit 1
+      - name: Get changed files in rde_schema folder
+        id: changed-rde
+        uses: tj-actions/changed-files@v47
+        with:
+          files: rde_schema/**
+
+      - name: Get changed files in markdown folder
+        id: changed-markdown
+        uses: tj-actions/changed-files@v47
+        with:
+          files: markdown/**
+
+      - name: Prevent running if no relevant files changed
+        if: steps.changed-schema.outputs.any_changed != 'true' && steps.changed-rde.outputs.any_changed != 'true'
+        run: echo "No relevant changes detected"
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: 3.11
 
       - name: Install dependencies
         run: |
           pip install -r resources/requirements.txt
 
-      - name: Generate Schema Documentation
+      - name: Generate Legacy Schema Documentation
+        if: steps.changed-schema.outputs.any_changed == 'true' || steps.changed-markdown.outputs.any_changed == 'true'
+        run: |
+          python resources/generate_markdown.py \
+            --input $GITHUB_WORKSPACE \
+            --mode legacy
+
+      - name: Generate Current Schema Documentation
+        if: steps.changed-rde.outputs.any_changed == 'true' || steps.changed-markdown.outputs.any_changed == 'true'
         run: |
-          python resources/generate_markdown_schema.py --source-dir $GITHUB_WORKSPACE
+          python resources/generate_markdown.py \
+            --input $GITHUB_WORKSPACE \
+            --mode current
 
       - name: Commit and push changes
         run: |
           git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
           git config user.name "${GITHUB_ACTOR}"
           git add markdown/
-          git commit -am "Generated new copy of schema in markdown"
+          git diff --cached --quiet || git commit -m "Generated new copy of schema in markdown"
           git push origin HEAD:$GITHUB_REF
 
       - name: Deploy to GitHub Pages

.gitignore

@@ -8,4 +8,16 @@ projects/terms_of_use/
 projects/jinja_tests/export_request-*.json
 projects/datacite/
 projects/ddi_doi_cleanup/input/
-projects/ddi_doi_cleanup/output
+projects/ddi_doi_cleanup/output
+rde_schema/property_bank/contributors.json
+rde_schema/property_bank/link_title.json
+rde_schema/property_bank/extent_of_processing.json
+rde_schema/property_bank/common_data_elements.json
+rde_schema/property_bank/deposits.json
+rde_schema/property_bank/restrictions.json
+rde_schema/property_bank/README.md
+rde_schema/property_bank/external_source_id.json
+rde_schema/property_bank/languages.json
+rde_schema/property_bank/oversamples.json
+rde_schema/property_bank/link_url.json
+rde_schema/property_bank/study_purpose.json

markdown/assets/style.css

@@ -122,7 +122,6 @@ a {
 }
 
 .wy-side-nav-search {
-    color: #ffffff;
     background-color: #115BFB;
 }