Skip to content

Commit 8855de8

Browse files
jgadsdenjgadsden
authored
update versions used in workflow steps
2 parents 7fa3dfe + 1d2a03f commit 8855de8

File tree

7 files changed

+106
-54
lines changed

7 files changed

+106
-54
lines changed

‎.github/workflows/ci.yaml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99
jobs:
1010
link_checker:
1111
name: Link checker
12-
runs-on: ubuntu-22.04
12+
runs-on: ubuntu-24.04
1313
steps:
1414
- name: Checkout markdown
1515
uses: actions/[email protected]
@@ -18,14 +18,14 @@ jobs:
1818
uses: lycheeverse/[email protected]
1919
with:
2020
# skip the jekyll files
21-
args: --verbose --no-progress --max-retries 5 --exclude-path './_includes/*.html' '**/*.md' '*.md'
21+
args: --no-progress --max-retries 5 --exclude-path './_includes/*.html' './draft/**/*.md' '*.md'
2222
fail: true
2323
env:
2424
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
2525

2626
md_linter:
2727
name: Lint markdown
28-
runs-on: ubuntu-22.04
28+
runs-on: ubuntu-24.04
2929
steps:
3030
- name: Checkout markdown
3131
uses: actions/[email protected]
@@ -38,10 +38,10 @@ jobs:
3838

3939
spell_checker:
4040
name: Check spelling
41-
runs-on: ubuntu-22.04
41+
runs-on: ubuntu-24.04
4242
steps:
4343
- name: Checkout markdown
4444
uses: actions/[email protected]
4545

4646
- name: spell_checker
47-
uses: rojopolis/spellcheck-github-actions@0.36.0
47+
uses: rojopolis/spellcheck-github-actions@0.37.0

‎.github/workflows/housekeeping.yaml‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99
jobs:
1010
chores:
1111
name: Tidy workflows
12-
runs-on: ubuntu-22.04
12+
runs-on: ubuntu-24.04
1313
permissions:
1414
actions: write
1515

@@ -29,7 +29,7 @@ jobs:
2929

3030
link_checker:
3131
name: Link checker
32-
runs-on: ubuntu-22.04
32+
runs-on: ubuntu-24.04
3333
steps:
3434
- name: Checkout markdown
3535
uses: actions/[email protected]
@@ -38,7 +38,28 @@ jobs:
3838
uses: lycheeverse/[email protected]
3939
with:
4040
# skip the jekyll files
41-
args: --verbose --no-progress --max-retries 5 --exclude-path './_includes/*.html' '**/*.md' '*.md'
41+
args: --no-progress --max-retries 5 --exclude-path './_includes/*.html' '**/*.md' '*.md'
4242
fail: true
4343
env:
4444
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
45+
46+
stale:
47+
name: Tidy pull requests
48+
runs-on: ubuntu-24.04
49+
permissions:
50+
pull-requests: write
51+
issues: write
52+
53+
steps:
54+
- name: Tidy stale PRs and issues
55+
uses: actions/stale@v9
56+
with:
57+
days-before-issue-stale: 182
58+
days-before-issue-close: -1
59+
stale-issue-message: 'This issue is stale because it has been open for 6 months with no activity.'
60+
stale-issue-label: stale
61+
remove-issue-stale-when-updated: true
62+
days-before-pr-stale: 90
63+
days-before-pr-close: 7
64+
stale-pr-message: 'This PR is stale because it has been open 90 days with no activity. Remove stale label, or add a comment, otherwise it will be closed in 7 days.'
65+
close-pr-message: 'This PR was closed because it has been stalled for over 3 months with no activity.'

‎.github/workflows/pr.yaml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99
jobs:
1010
link_checker:
1111
name: Link checker
12-
runs-on: ubuntu-22.04
12+
runs-on: ubuntu-24.04
1313
steps:
1414
- name: Checkout markdown
1515
uses: actions/[email protected]
@@ -18,14 +18,14 @@ jobs:
1818
uses: lycheeverse/[email protected]
1919
with:
2020
# skip the jekyll files
21-
args: --verbose --no-progress --max-retries 5 --exclude-path './_includes/*.html' '**/*.md' '*.md'
21+
args: --verbose --no-progress --max-retries 5 --exclude-path './_includes/*.html' './draft/**/*.md' '*.md'
2222
fail: true
2323
env:
2424
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
2525

2626
md_linter:
2727
name: Lint markdown
28-
runs-on: ubuntu-22.04
28+
runs-on: ubuntu-24.04
2929
steps:
3030
- name: Checkout markdown
3131
uses: actions/[email protected]
@@ -38,17 +38,17 @@ jobs:
3838

3939
spell_checker:
4040
name: Check spelling
41-
runs-on: ubuntu-22.04
41+
runs-on: ubuntu-24.04
4242
steps:
4343
- name: Checkout markdown
4444
uses: actions/[email protected]
4545

4646
- name: spell_checker
47-
uses: rojopolis/spellcheck-github-actions@0.36.0
47+
uses: rojopolis/spellcheck-github-actions@0.37.0
4848

4949
export_draft:
5050
name: Export epub and pdf (Draft)
51-
runs-on: ubuntu-22.04
51+
runs-on: ubuntu-24.04
5252
needs: [link_checker, md_linter, spell_checker]
5353
steps:
5454
- name: Checkout markdown

‎.github/workflows/release.yaml‎

Lines changed: 56 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -9,38 +9,33 @@ on:
99

1010
# for security reasons the github actions are pinned to specific release versions
1111
jobs:
12-
create_release:
13-
name: Release pull-request
14-
runs-on: ubuntu-22.04
12+
create_artifacts:
13+
name: Create artifacts
14+
runs-on: ubuntu-24.04
1515

1616
steps:
1717
- name: Checkout markdown
1818
uses: actions/[email protected]
1919

20-
- name: Promote draft to release
20+
- name: Fix up markdown
2121
run: |
2222
echo "GITHUB_WORKFLOW: ${GITHUB_WORKFLOW}"
2323
echo "GITHUB_REF_NAME: ${GITHUB_REF_NAME}"
24-
cd draft
2524
pwd
26-
find . -name "*.md" ! -name "info.md" -exec cp '{}' '../release/{}' \;
27-
28-
- name: Fix up markdown
29-
run: |
30-
pwd
31-
find release -name "*.md" -exec sed -i "s|permalink: /draft/|permalink: /release/|" {} +
32-
find release -name "*.md" -exec sed -i "/The OWASP Developer Guide is a community effort/d" {} +
33-
find release -name "*.md" -exec sed -i "/edit on GitHub/d" {} +
34-
find release -name "*.md" -exec sed -i "/www-project-developer-guide\/issues\/new?labels/d" {} +
35-
find release -name "*.md" -exec sed -i "/www-project-developer-guide\/blob\/main/d" {} +
36-
find release -name "*.md" -exec \
25+
echo "rename draft to release"
26+
find draft -name "*.md" -exec sed -i "s|permalink: /draft/|permalink: /release/|" {} +
27+
find draft -name "*.md" -exec \
3728
sed -i "s/.*the latest contributions to the Developer Guide.*/\#\#\# Release version $GITHUB_REF_NAME/" {} +
38-
find release -name "*.md" -exec sed -i "s/ (Draft)//gI" {} +
39-
find release -name "*.md" -exec sed -i "/order: / s/$/0/" {} +
29+
find draft -name "*.md" -exec sed -i "s/ (Draft)//gI" {} +
30+
echo "remove contributing footer"
31+
find draft -name "*.md" -exec sed -i "/The OWASP Developer Guide is a community effort/d" {} +
32+
find draft -name "*.md" -exec sed -i "/edit on GitHub/d" {} +
33+
find draft -name "*.md" -exec sed -i "/www-project-developer-guide\/issues\/new?labels/d" {} +
34+
find draft -name "*.md" -exec sed -i "/www-project-developer-guide\/blob\/main/d" {} +
4035
4136
- name: Combine markdown
4237
run: |
43-
tail --lines=+14 -q $(find release -name "*[0-9]*.md" | sort) > release.markdown
38+
tail --lines=+14 -q $(find draft -name "*[0-9]*.md" | sort) > release.markdown
4439
mkdir -p publish
4540
4641
- name: Export to pdf
@@ -63,48 +58,70 @@ jobs:
6358
release/title.yaml
6459
release.markdown
6560
66-
- name: Save pdfs and epubs
61+
- name: Store pdf and epub assets
6762
uses: actions/[email protected]
6863
with:
6964
name: export-docs
7065
path: publish
7166

72-
- name: Update pdfs and epubs
73-
run: |
74-
pwd && ls -hal publish
75-
cp publish/OWASP_Developer_Guide.* assets/exports/.
67+
create_release:
68+
name: Create pull request
69+
runs-on: ubuntu-24.04
70+
needs: create_artifacts
71+
72+
steps:
73+
- name: Checkout markdown
74+
uses: actions/[email protected]
7675

77-
- name: Remove newpage tags
76+
- name: Promote draft to release
7877
run: |
79-
find release -name "*.md" -exec sed -i '/newpage/d' {} +
78+
echo "GITHUB_WORKFLOW: ${GITHUB_WORKFLOW}"
79+
echo "GITHUB_REF_NAME: ${GITHUB_REF_NAME}"
80+
cd draft && find . -name "*.md" ! -name "info.md" -exec cp '{}' '../release/{}' \;
8081
81-
- name: Remove multiple blank lines
82+
- name: Fix up markdown
8283
run: |
84+
pwd
85+
echo "rename draft to release"
86+
find release -name "*.md" -exec sed -i "s|permalink: /draft/|permalink: /release/|" {} +
87+
find release -name "*.md" -exec \
88+
sed -i "s/.*the latest contributions to the Developer Guide.*/\#\#\# Release version $GITHUB_REF_NAME/" {} +
89+
find release -name "*.md" -exec sed -i "s/ (Draft)//gI" {} +
90+
echo "revise page ordering"
91+
find release -name "*.md" -exec sed -i "/order: / s/$/0/" {} +
92+
echo "remove newpage tags"
93+
find release -name "*.md" -exec sed -i '/newpage/d' {} +
94+
echo "Remove multiple blank lines"
8395
find release -name "*.md" -exec sed -i ':a; /^\n*$/{ s/\n//; N; ba};' {} +
8496
find release -name "*.md" -exec sed -i '${/^$/d;}' {} +
8597
98+
- name: Retrieve pdfs and epubs
99+
uses: actions/[email protected]
100+
with:
101+
name: export-docs
102+
103+
- name: Update pdf and epub assets
104+
run: |
105+
pwd && ls -hal
106+
cp OWASP_Developer_Guide.pdf assets/exports/.
107+
cp OWASP_Developer_Guide.epub assets/exports/.
108+
86109
- name: Create pull request
87110
uses: peter-evans/[email protected]
88111
with:
89112
title: |
90-
Release ${{ github.ref_name }} of Developer Guide
113+
Release ${{ github.ref_name }} of Developer Guide
91114
body: |
92115
**Summary** :
93-
Pull request automatically generated for the latest release version
116+
Automatically generated pull-request for the latest release version
94117
95118
**Description for the changelog** :
96-
release of version ${{ github.ref_name }}
119+
release of version ${{ github.ref_name }}
97120
98121
**Other info** :
99-
Please verify and then merge the pull request to update the release
100-
commit-message: update to release version ${{ github.ref_name }}
122+
Please verify and then update the release by merging the pull request
123+
commit-message: update to release version ${{ github.ref_name }}
101124
branch: update-release
102125
base: main
103126
labels: release
104-
assignees: jgadsden
105-
reviewers: |
106-
jgadsden
107-
alezza
108-
Shruti-s-kulkarni
109-
hblankenship
110-
draft: false
127+
draft: false

‎draft/04-foundations/05-top-ten.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ may also be referred to as 'OWASP Top 10'. Here is a list of the stable 'OWASP T
175175
* [Top 10 Proactive Controls][proactive10]
176176
* [Top 10 Web Application Security Risks][top10]
177177

178-
Many of the OWASP Top 10s that are being worked on as 'incubator' projects so this list will change.
178+
Other OWASP Top 10s are 'incubator' projects, work in progress, so this list will change over time.
179179

180180
----
181181

‎draft/12-metrics/00-toc.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ order:
1313

1414
## 10. Metrics
1515

16+
Metrics are important in an organization for various reasons, and in software security they can be used to:
17+
18+
* measure the effectiveness of security controls
19+
* determine security posture
20+
* provide justification for security programs
21+
* and others
22+
1623
At present the OWASP [Integration Standards project Application Wayfinder][wayfinder] project
1724
does not identify any OWASP projects that gather or process metrics, but this may change in the future.
1825

‎draft/12-metrics/toc.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ permalink: /draft/metrics/
1414

1515
## 10. Metrics
1616

17+
Metrics are important in an organization for various reasons, and in software security they can be used to:
18+
19+
* measure the effectiveness of security controls
20+
* determine security posture
21+
* provide justification for security programs
22+
* and others
23+
1724
At present the OWASP [Integration Standards project Application Wayfinder][wayfinder] project
1825
does not identify any OWASP projects that gather or process metrics, but this may change in the future.
1926

0 commit comments

Comments
 (0)