step by step release process (#86)

Author: jgadsden

.github/workflows/ci.yaml

@@ -35,5 +35,14 @@ jobs:
           pip install mkdocs-open-in-new-tab
           pip install mkdocs-with-pdf
 
+      - name: Build check
+        run: mkdocs build
+
       - name: Deploy
         run: mkdocs gh-deploy --force --verbose
+
+      - name: Upload PDF
+        uses: actions/[email protected]
+        with:
+          name: pdf-export
+          path: site/OWASP_Developer_Guide.pdf

.github/workflows/pr.yaml

@@ -72,11 +72,5 @@ jobs:
           pip install mkdocs-open-in-new-tab
           pip install mkdocs-with-pdf
 
-      - name: Build
+      - name: Build check
         run: mkdocs build
-
-      - name: Upload PDF
-        uses: actions/[email protected]
-        with:
-          name: pdf-export
-          path: site/OWASP_Developer_Guide.pdf

.gitignore

@@ -8,8 +8,6 @@
 !CNAME
 !docs/
 !docs/assets/
-!docs/assets/exports/
-!docs/assets/exports/*.pdf
 !docs/assets/images/
 !docs/assets/images/*.png
 !docs/assets/images/logos/

.release-note-template.md

@@ -99,7 +99,7 @@ The pull requests have checks applied to them:
 The pipeline will apply checks to all pull-requests, and will fail on any error.
 To run these checks locally before pushing a commit, run these commands from the top directory:
 
-1. Link checker: `lychee --max-retries 5 --exclude-path './_includes/*.html' './**/*.md'`
+1. Link checker: `lychee --max-retries 5 './**/*.md'`
 2. Markdown linter: `markdownlint-cli2  **/*.md`
 3. Spell checker: `pyspelling --config .spellcheck-en.yaml` (for English language version)
 

contributing.md

@@ -0,0 +1,40 @@
+### Release process
+
+The [web document][latest] is always the latest version that has been accepted via the pull request process.
+
+If major or significant minor changes are made then it is good to tag this with a semantic version, such as `4.1.8`.
+
+To do this:
+
+1. Ensure that all pull-requests are up to date
+2. navigate to the [release area][release]
+3. Click on the 'Draft a new release' button to create a [new release][new-release]
+4. Choose a tag, for example `v4.1.8` and select target branch to be 'main'
+5. Provide the release title, such as 'Version 4.1.8'
+6. Describe the release in the Description, consider including the text below
+7. Obtain the latest PDF file form the latest (successful) [commit action][commits]
+8. Upload this PDF file to the draft release
+9. Ensure 'Set as the latest release' is selected
+10. Apply 'Publish release'
+11. Announce on Slack channel
+12. Announce on Blue Sky channel
+
+
+```
+Contact the current [leaders][leaders] for any queries about this version.
+
+The [PDF][pdf-guide] version of the [web document][devguide] can be downloaded for version 4.1.8 .
+
+[devguide]: devguide.owasp.org
+[leaders]: https://github.com/OWASP/www-project-developer-guide/blob/main/leaders.md
+[pdf-guide]: https://github.com/OWASP/threat-dragon/releases/download/v4.1.8/OWASP_Developer_Guide-V4.1.8.pdf
+```
+
+----
+
+OWASP DevGuide: _accessible security for developers_
+
+[commits]: https://github.com/OWASP/DevGuide/actions/workflows/ci.yaml
+[latest]: https://devguide.owasp.org/
+[new-release]: https://github.com/OWASP/DevGuide/releases/new
+[release]: https://github.com/OWASP/DevGuide/releases