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.

Sign up for GitHub

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

Make GHA workflow reusable #407

Closed
wants to merge 6 commits into from
Closed

Make GHA workflow reusable #407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fa5dda7
Make workflow reusable
SaschaMann Mar 9, 2022
6df6963
Rename secret to match workflow
SaschaMann Mar 9, 2022
082b109
Undo rename as the workflow requires it to be called DOCUMENTER_KEY
SaschaMann Mar 9, 2022
caa1f4b
Add to README
SaschaMann Mar 9, 2022
1b7831e
Fix branch name
SaschaMann Mar 9, 2022
4732ccb
Require key
SaschaMann Mar 9, 2022
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
5 changes: 5 additions & 0 deletions .github/workflows/CompatHelper.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ on:
schedule:
- cron: 0 0 * * *
workflow_dispatch:
workflow_call:
secrets:
DOCUMENTER_KEY:
description: 'An SSH deploy key. See docs for more info.'
required: true
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this actually required? I'm never sure.

If not:

Suggested change
required: true
required: false

jobs:
CompatHelper:
runs-on: ubuntu-latest
Expand Down
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,23 @@ Create a file at `.github/workflows/CompatHelper.yml` with the contents of the [

If you need to use any special arguments for the `main` function, you can modify this file to add them.

You can also use a [reusable workflow](https://docs.github.com/en/actions/using-workflows/reusing-workflows):

```yaml
name: CompatHelper

on:
workflow_dispatch:
schedule:
- cron: 0 0 1 * * # First day of each month

jobs:
compathelper:
uses: JuliaRegistries/CompatHelper.jl/.github/workflows/CompatHelper.yml@master
secrets:
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
```

### GitLab
For GitLab you will want to add CompatHelper as a job in your `.gitlab-ci.yml` file such as:

Expand Down