https://github.com/goauthentik/configure-authentik-credentials
Authenticate to an authentik application in GitHub actions
https://github.com/goauthentik/configure-authentik-credentials
Last synced: over 1 year ago
JSON representation
Authenticate to an authentik application in GitHub actions
- Host: GitHub
- URL: https://github.com/goauthentik/configure-authentik-credentials
- Owner: goauthentik
- License: mit
- Created: 2024-09-15T22:57:25.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T13:47:00.000Z (over 1 year ago)
- Last Synced: 2025-03-16T11:33:57.581Z (over 1 year ago)
- Language: TypeScript
- Size: 1.32 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
[](https://github.com/goauthentik/configure-authentik-credentials/actions/workflows/ci.yml)
[](https://github.com/goauthentik/configure-authentik-credentials/actions/workflows/check-dist.yml)
[](https://github.com/goauthentik/configure-authentik-credentials/actions/workflows/codeql-analysis.yml)
[](https://codecov.io/gh/goauthentik/configure-authentik-credentials)
# configure-authentik-credentials GitHub Action
Use this action to authenticate to an application protected by authentik using the JWT token
generated by GitHub Actions.
## Usage
After testing, you can create version tag(s) that developers can use to reference different stable
versions of your action. For more information, see
[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) in the GitHub
Actions toolkit.
To include the action in a workflow in another repository, you can use the `uses` syntax with the
`@` symbol to reference a specific branch, tag, or commit hash.
```yaml
steps:
- name: Checkout
id: checkout
uses: actions/checkout@v4
- name: Get authentik token
id: authentik-token
uses: goauthentik/configure-authentik-credentials@v1 # Commit with the `v1` tag
with:
authentik_url: https://id.goauthentik.io
client_id: foobar
- name: Use the token
run: |
${{ steps.authentik-token.outputs.token }}
```
## Publishing a New Release
This project includes a helper script, [`script/release`](./script/release) designed to streamline
the process of tagging and pushing new releases for GitHub Actions.
GitHub Actions allows users to select a specific version of the action to use, based on release
tags. This script simplifies this process by performing the following steps:
1. **Retrieving the latest release tag:** The script starts by fetching the most recent SemVer
release tag of the current branch, by looking at the local data available in your repository.
1. **Prompting for a new release tag:** The user is then prompted to enter a new release tag. To
assist with this, the script displays the tag retrieved in the previous step, and validates the
format of the inputted tag (vX.X.X). The user is also reminded to update the version field in
package.json.
1. **Tagging the new release:** The script then tags a new release and syncs the separate major tag
(e.g. v1, v2) with the new release tag (e.g. v1.0.0, v2.1.2). When the user is creating a new
major release, the script auto-detects this and creates a `releases/v#` branch for the previous
major version.
1. **Pushing changes to remote:** Finally, the script pushes the necessary commits, tags and
branches to the remote repository. From here, you will need to create a new release in GitHub so
users can easily reference the new tags in their workflows.