Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/sphinx synch #56

Merged
merged 60 commits into from
Feb 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
fdfde01
build(release): release version 2.4.3
nicholasphair Feb 28, 2024
69e0d95
build(release): release version 2.4.4
nicholasphair Feb 28, 2024
a7c09ec
build(release): release version 3.0.0
nicholasphair Feb 28, 2024
0479dd5
build(release): release version 3.0.1
nicholasphair Feb 28, 2024
1fe55d1
build(release): release version 3.0.2
nicholasphair Feb 28, 2024
9e2f887
build(release): release version 3.0.3
nicholasphair Feb 28, 2024
4cb5e8a
build(release): release version 3.0.4
nicholasphair Feb 28, 2024
1735fba
build(release): release version 3.1.0
nicholasphair Feb 28, 2024
bfd601b
build(release): release version 3.1.1
nicholasphair Feb 28, 2024
929fa52
build(release): release version 3.1.2
nicholasphair Feb 28, 2024
0af0ae3
build(release): release version 3.2.0
nicholasphair Feb 28, 2024
08fb14b
build(release): release version 3.2.1
nicholasphair Feb 28, 2024
d656594
build(release): release version 3.3.0
nicholasphair Feb 28, 2024
b9dc931
build(release): release version 3.3.1
nicholasphair Feb 28, 2024
84b1b56
build(release): release version 3.4.0
nicholasphair Feb 28, 2024
7840173
build(release): release version 3.4.1
nicholasphair Feb 28, 2024
96378d2
build(release): release version 3.4.2
nicholasphair Feb 28, 2024
3edd253
build(release): release version 3.4.3
nicholasphair Feb 28, 2024
bcadc79
build(release): release version 3.5.0
nicholasphair Feb 28, 2024
1cdf49d
build(release): release version 3.5.1
nicholasphair Feb 28, 2024
f8122ee
build(release): release version 3.5.2
nicholasphair Feb 28, 2024
59f5f36
build(release): release version 3.5.3
nicholasphair Feb 28, 2024
1c82dcc
build(release): release version 3.5.4
nicholasphair Feb 28, 2024
72491f6
build(release): release version 4.0.0
nicholasphair Feb 28, 2024
859dc29
build(release): release version 4.0.1
nicholasphair Feb 28, 2024
01e30fc
build(release): release version 4.0.2
nicholasphair Feb 28, 2024
828a0c1
build(release): release version 4.0.3
nicholasphair Feb 28, 2024
5d91078
build(release): release version 4.1.0
nicholasphair Feb 28, 2024
98a04f0
build(release): release version 4.1.1
nicholasphair Feb 28, 2024
00166bc
build(release): release version 4.1.2
nicholasphair Feb 28, 2024
0e53f7e
build(release): release version 4.2.0
nicholasphair Feb 28, 2024
66722aa
build(release): release version 4.3.0
nicholasphair Feb 28, 2024
f4899f0
build(release): release version 4.3.1
nicholasphair Feb 28, 2024
be4a2e7
build(release): release version 4.3.2
nicholasphair Feb 28, 2024
a1a0312
build(release): release version 4.4.0
nicholasphair Feb 28, 2024
6fd7dc7
build(release): release version 4.5.0
nicholasphair Feb 28, 2024
729b090
build(release): release version 5.0.0
nicholasphair Feb 28, 2024
2400e83
build(release): release version 5.0.1
nicholasphair Feb 28, 2024
23f9576
build(release): release version 5.0.2
nicholasphair Feb 28, 2024
26b4219
build(release): release version 5.1.0
nicholasphair Feb 28, 2024
128589b
build(release): release version 5.1.1
nicholasphair Feb 28, 2024
d32496a
build(release): release version 5.2.0
nicholasphair Feb 28, 2024
087e78b
build(release): release version 5.2.1
nicholasphair Feb 28, 2024
7764c27
build(release): release version 5.2.2
nicholasphair Feb 28, 2024
d29db20
build(release): release version 5.3.0
nicholasphair Feb 28, 2024
3fce3fc
build(release): release version 6.0.0
nicholasphair Feb 28, 2024
00d4922
build(release): release version 6.0.1
nicholasphair Feb 28, 2024
67d204e
build(release): release version 6.1.0
nicholasphair Feb 28, 2024
f3e8847
build(release): release version 6.1.1
nicholasphair Feb 28, 2024
77a9816
build(release): release version 6.1.2
nicholasphair Feb 28, 2024
2dd3d73
build(release): release version 6.1.3
nicholasphair Feb 28, 2024
3eaef77
build(release): release version 6.2.0
nicholasphair Feb 28, 2024
e4404c4
build(release): release version 6.2.1
nicholasphair Feb 28, 2024
340a61b
build(release): release version 7.0.0
nicholasphair Feb 28, 2024
6b9ebb6
build(release): release version 7.0.1
nicholasphair Feb 28, 2024
e91e124
build(release): release version 7.1.0
nicholasphair Feb 28, 2024
a4a9533
build(release): release version 7.1.1
nicholasphair Feb 28, 2024
82c2539
build(release): release version 7.1.2
nicholasphair Feb 28, 2024
f9b3fec
initial automatic sync commit
nicholasphair Feb 28, 2024
5613434
describe version selection in README
nicholasphair Feb 29, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/synchronize.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Daily check for new Sphinx dockers to build against.

on:
schedule:
# Runs at midnight UTC every day.
- cron: '0 0 * * *'

jobs:
run-shell-script:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Run a shell script
run: |
./bin/tryrelease
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM sphinxdoc/sphinx:2.4.4
FROM sphinxdoc/sphinx:7.1.2

LABEL "maintainer"="Ammar Askar <ammar@ammaraskar.com>"

Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ jobs:
docs-folder: "docs/"
```

* You can choose a Sphinx version by using the appropriate tag. For example, to
specify Sphinx 7.0.0 you would use `ammaraskar/sphinx-action@7.0.0`. `master`
currently uses Sphinx 2.4.4.

* If you have any Python dependencies that your project needs (themes,
build tools, etc) then place them in a requirements.txt file inside your docs
folder.
Expand Down
38 changes: 38 additions & 0 deletions bin/tryrelease
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
#!/usr/bin/env bash

DOCKERFILE="Dockerfile"
: ${RUNNER_TEMP:=/tmp}


fetch_current_tags() {
gh api repos/:owner/:repo/git/refs/tags \
--jq '.[]' -q '.[] | .ref' |
cut -d'/' -f3 |
sort
}

fetch_sphinx_image_tags() {
gh api repos/sphinx-doc/sphinx-docker-images/git/refs/tags \
--jq '.[]' -q '.[] | .ref' |
cut -d'/' -f3 |
sort
}

NEW_TAGS="${RUNNER_TEMP}/new_tags.txt"
comm -13 <(fetch_current_tags) <(fetch_sphinx_image_tags) > "$NEW_TAGS"
if [ ! -s "$NEW_TAGS" ]; then
echo "No new tags found."
exit 0
fi

while IFS= read -r tag; do
sed -i "1s#.*#FROM sphinxdoc/sphinx:${tag}#g" "$DOCKERFILE"

git add "$DOCKERFILE"
git commit --message "build(release): release version ${tag}"
git tag "$tag"
git push --tags
done < "$NEW_TAGS"

rm "$NEW_TAGS"