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

Workflow now invoked also when tag v* is created. / README polish. #52

Merged
merged 2 commits into from
Jan 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 19 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
name: Flow-IPC pipeline

on:
push:
# Want to merge to development tip? Should probably pass these builds/tests/doc generation first.
pull_request:
branches:
- main
pull_request:
push:
# Was able to merge to development tip? Should ensure these builds/tests/doc generation pass after the fact;
# plus auto-check-in generated docs into development tip branch as well (and signal web site to update accordingly).
branches:
- main
# Created release tag? Just in case, should ensure these builds/tests/doc generation pass after the fact still;
# plus signal web site to update accordingly (new release/docs for it).
tags:
- v*
# To create the button that runs a workflow manually (has to be in `main` at least):
workflow_dispatch:

Expand Down Expand Up @@ -1089,3 +1096,13 @@ jobs:
-H 'Authorization: token ${{ secrets.GIT_BOT_PAT }}' \
'https://api.github.com/repos/Flow-IPC/flow-ipc.github.io/dispatches' \
-d '{"event_type": "flow-ipc-sync-doc-event"}'

- name: Signal Pages if this is running due to release creation (then web site should update)
if: success() && startsWith(github.ref, 'refs/tags/v')
run: |
# Signal Pages if this is running due to release creation (then web site should update).
curl -X POST \
-H 'Accept: application/vnd.github.v3+json' \
-H 'Authorization: token ${{ secrets.GIT_BOT_PAT }}' \
'https://api.github.com/repos/Flow-IPC/flow-ipc.github.io/dispatches' \
-d '{"event_type": "flow-ipc-sync-doc-event", "client_payload": {"version": "${{ github.ref_name }}"}}'
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

What's this, you ask?
- We immediately point you to this
[introductory page](https://flow-ipc.github.io/doc/flow-ipc/versions/main/generated/html_public/about.html)
in the project's main documentation. Full documentation for the tip of the master branch is reachable from there also.
- The [project web site](https://flow-ipc.github.io) will help navigate various released versions and their
[introductory docs page](https://flow-ipc.github.io/doc/flow-ipc/versions/main/generated/html_public/about.html)
in the project's main documentation for the master branch.
- The [project web site](https://flow-ipc.github.io) provides access to various released versions and their
corresponding sets of such documentation.

The text just below covers some of the same ground -- just in case -- but the true documentation is hosted online at
Expand Down
Loading