create a new area for the developer guide release version

Author: jgadsden

.github/workflows/release.yaml

@@ -9,53 +9,29 @@ on:
 
 # for security reasons the github actions are pinned to specific release versions
 jobs:
-  link_checker:
-    name: Link checker
-    runs-on: ubuntu-22.04
-    steps:
-      - name: Checkout markdown
-        uses: actions/[email protected]
-
-      - name: Link Checker
-        uses: lycheeverse/[email protected]
-        with:
-          # skip the jekyll files
-          args: --verbose --no-progress --max-retries 5 --exclude-path './_includes/*.html' '**/*.md' '*.md'
-          fail: true
-        env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-
-  md_linter:
-    name: Lint markdown
-    runs-on: ubuntu-22.04
-    steps:
-      - name: Checkout markdown
-        uses: actions/[email protected]
-
-      - name: Lint markdown
-        uses: DavidAnson/[email protected]
-        with:
-          config: '.markdownlint.yaml'
-          globs: '**/*.md'
-
-  spell_checker:
-    name: Check spelling
-    runs-on: ubuntu-22.04
-    steps:
-      - name: Checkout markdown
-        uses: actions/[email protected]
-
-      - name: spell_checker
-        uses: rojopolis/[email protected]
-
   export_docs:
     name: Export PDF and ePub
     runs-on: ubuntu-22.04
-    needs: [link_checker, md_linter, spell_checker]
     steps:
       - name: Checkout markdown
         uses: actions/[email protected]
 
+      - name: Promote draft to release
+        run: |
+          cd draft
+          pwd
+          find . -name "*.md" ! -name "info.md" ! -name "01-front.md" -exec cp '{}' '../release/{}' \;
+
+      - name: Fix up markdown
+        run: |
+          pwd
+          find release -name "*.md" -exec sed -i '' "s|permalink: /draft/|permalink: /release/|g" {} +
+          find release -name "*.md" -exec sed -i '' "/The OWASP Developer Guide is a community effort/d" {} +
+          find release -name "*.md" -exec sed -i '' "/edit on GitHub/d" {} +
+          find release -name "*.md" -exec sed -i '' "/www-project-developer-guide\/issues\/new?labels/d" {} +
+          find release -name "*.md" -exec sed -i '' "/www-project-developer-guide\/blob\/main/d" {} +
+          find release -name "*.md" -exec sed -i '' "/^$/N;/^\n$/D" {} +
+
       - name: Combine markdown
         run: |
           tail --lines=+14 -q $(find release -name "*[0-9]*.md" | sort) > release.markdown
@@ -86,3 +62,20 @@ jobs:
         with:
           name: export-docs
           path: publish
+
+      - name: Update pdfs and epubs
+        run: |
+          pwd && ls -hal publish
+          cp publish/OWASP_Developer_Guide.* assets/exports/.
+
+      - name: Create pull request
+        uses: peter-evans/[email protected]
+        with:
+          title: 'Release'
+          body: |
+            ### Automatically generated
+            ---
+            Please verify and then **Merge** the pull request to update the release
+          commit-message: 'update release'
+          branch: update-release
+          base: main

.gitignore

@@ -42,6 +42,25 @@
 !draft/assets/images/
 !draft/assets/images/*.png
 
+# release version
+!release/
+!release/title*.yaml
+!release/0*/
+!release/0*/*.md
+!release/0*/0*/
+!release/0*/0*/*.md
+!release/0*/1*/
+!release/0*/1*/*.md
+!release/1*/
+!release/1*/*.md
+!release/1*/0*/
+!release/1*/0*/*.md
+!release/1*/1*/
+!release/1*/1*/*.md
+!release/assets/
+!release/assets/images/
+!release/assets/images/*.png
+
 # pages markdown
 !*.md
 !assets/

README.md

@@ -15,10 +15,11 @@ The [original DevGuide repository][devguide] has many of the [previous versions]
 going back to the [original version 1.0][original] from 2002.
 Note that the original DevGuide repository has been deprecated in favour of this one.
 
-The source code for the latest draft developer guide can be found under the ['draft'][draft] directory.
+The source for the latest draft developer guide can be found under the ['draft'][draft] directory.
 The source is in markdown and is used to create the developer guide HTML, PDF and ePub outputs.
 The content is subject to large scale changes with no notice,
-as it is being actively worked on for the next release of the Developer Guide.
+and is usually being actively worked on for the latest release
+of the Developer Guide under the ['release'][release] directory.
 
 ### Contributing
 
@@ -48,5 +49,6 @@ is via the OWASP Slack [#project-developer-guide][project] project channel
 [original]: https://github.com/OWASP/DevGuide/blob/1d24d140de3724b6f95655e53b8d0cc6689fbfd8/DevGuide1.0/OWASPBuildingSecureWebApplicationsAndWebServices-V1.0.pdf
 [pages]: https://owasp.org/www-project-developer-guide/
 [project]: https://owasp.slack.com/messages/C04QN6CMNAC
+[release]: release
 [request]: https://github.com/OWASP/www-project-developer-guide/pulls
 [versions]: https://github.com/OWASP/DevGuide/wiki#old-versions