Skip to content

Commit

Permalink
Enable prod doc updates without release (#395)
Browse files Browse the repository at this point in the history
  • Loading branch information
Blacksmoke16 authored Apr 9, 2024
1 parent df3082c commit ef0ddb3
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: Release

on:
workflow_dispatch:
repository_dispatch:
types: [docs]

Expand All @@ -16,6 +17,8 @@ jobs:
uses: crystal-lang/install-crystal@v1
- name: Install Components
run: shards install --without-development
env:
SHARDS_OVERRIDE: shard.prod.yml
- uses: actions/setup-python@v5
with:
python-version: 3.x
Expand Down
4 changes: 4 additions & 0 deletions scripts/release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ function tag()
git tag -asm "$MESSAGE" $TAG
git push --quiet origin $TAG

# Be sure to reset `docs` branch back to current state of `master` as a release assumes the previously cherry-picked commits are now inherently included
git branch --quiet --force docs master
git push --quiet origin docs --force

printf "Tagged \e]8;;https://github.com/athena-framework/%s/releases/tag/%s\e\\%s\e]8;;\e\\ \n" $1 $TAG "$MESSAGE"

cd $OLDPWD
Expand Down
42 changes: 42 additions & 0 deletions shard.prod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Used for prod builds of the docs to ensure API docs can be updated w/o a dedicated release
# $ SHARDS_OVERRIDE=shard.prod.yml shards update
dependencies:
athena:
github: athena-framework/framework
branch: docs
athena-clock:
github: athena-framework/clock
branch: docs
athena-console:
github: athena-framework/console
branch: docs
athena-dependency_injection:
github: athena-framework/dependency-injection
branch: docs
athena-dotenv:
github: athena-framework/dotenv
branch: docs
athena-event_dispatcher:
github: athena-framework/event-dispatcher
branch: docs
athena-image_size:
github: athena-framework/image-size
branch: docs
athena-mercure:
github: athena-framework/mercure
branch: docs
athena-negotiation:
github: athena-framework/negotiation
branch: docs
athena-routing:
github: athena-framework/routing
branch: docs
athena-serializer:
github: athena-framework/serializer
branch: docs
athena-spec:
github: athena-framework/spec
branch: docs
athena-validator:
github: athena-framework/validator
branch: docs

0 comments on commit ef0ddb3

Please sign in to comment.