Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/equinor/radix-github-actions
https://github.com/equinor/radix-github-actions
cicd github-actions kubernetes omnia-radix radix-cli
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/equinor/radix-github-actions
- Owner: equinor
- License: mit
- Created: 2019-12-20T14:34:57.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T13:29:14.000Z (10 months ago)
- Last Synced: 2024-04-12T20:47:34.161Z (10 months ago)
- Topics: cicd, github-actions, kubernetes, omnia-radix, radix-cli
- Language: Shell
- Homepage:
- Size: 65.4 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# GitHub Action for Radix CLI
This Action for [Radix CLI](https://github.com/equinor/radix-cli) to integrate with the Radix platform from a GitHub Action workflow.
## Contribution
Want to contribute? Read our [contributing guidelines](./CONTRIBUTING.md)
## Outputs
### `result`
The standard output from execution of the `rx` command.
## Usage
This Action can be used to run any `rx` command. The run make some assumptions:
- An environment variable with the `APP_SERVICE_ACCOUNT_TOKEN` is available to the app, and this token belongs to a user or service principal who has the appropriate privileges for the operations you want to execute in the Radix cluster. [See our documentation](https://www.radix.equinor.com/guides/deploy-only/example-github-action-using-ad-service-principal-access-token.html#example-of-using-ad-service-principal-to-get-access-to-a-radix-application-in-a-github-action) for example on how to acquire such a token in a GitHub Actions workflow. The environment variable can be set on a single step or on the entire flow.
All the examples below pass the `github-token` argument to the Action. Passing this argument is optional. The caveat of *not* passing this argument is that it gets more likely that the workflow fails because the hourly GitHub API rate limit has been exhausted. The Action uses to GitHub API to determine the most recent version of the `rx` CLI.
Examples:
```yaml
- name: Deploy on Radix
uses: equinor/radix-github-actions@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
args: >
create job
deploy
-a application-name
-e ${{ steps.getEnvironment.outputs.result }}
-f
```
`-f` will ensure that the action step is followed, and won't continue until step is complete.
```yaml
- name: Deploy on Radix
uses: equinor/radix-github-actions@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
args: >
create job
deploy
--context playground
-a application-name
-e ${{ steps.getEnvironment.outputs.result }}
-f
```
`--from-config` will read information such as application-name, branch mapping etc from your radixconfig.yaml
```yaml
- name: Deploy on radix
uses: equinor/radix-github-actions@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
args: >
create job
deploy
--from-config
-e ${{ steps.getEnvironment.outputs.result }}
-f
```
`--context playground` will communicate with playground cluster, if your application resides there.
```yaml
- name: Set component environment secret
uses: equinor/radix-github-actions@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
args: >
set environment-secret
--from-config
-e
--component
-s
-v ''
```
```yaml
- name: Get environment from branch mapping in Radix config for repository
id: getEnvironment
uses: equinor/radix-github-actions@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
args: >
get-config branch-environment
--from-config
-b ${GITHUB_REF##*/}
- name: Print the environment
run: echo "${{ steps.getEnvironment.outputs.result }}"
```
## Release
Triger `Step 1 - Create pull requets with new version` workflow and set the semver option to the correct version (must be a valid semver with `Major.Minor.Patch` format).
The GitHub Workflow modifies the `Dockerfile` with the updated `RX_VERSION` set to your `semver` and create a new pull-request for you to approve.
You can also run this locally in the repository with `gh workflow run ci-step1.yaml --repository github.com/equinor/radix-github-actions --field semver=1.X.X`
1. Release Radix-Cli 1.11.0
2. Trigger `Step 1 - Create pull requets with new version` Action 1.11.0
- Modifies Dockerfile with the new RX_VERSION.
- Creates a new branch and a PR
3. Testing: run a test-workflow with eg. equinor/radix-github-action@update-rx-version-1-x-x
4. Manually Merge PR
5. The workflow `Step 2 - Tag commit with new version` will parse `RX_VERSION` from the `Dockerfile` and create/update the relevant tags.
## License
The Dockerfile and associated scripts and documentation in this project are released under the [MIT License](LICENSE).
## Security
This is how we handle [security issues](./SECURITY.md)