Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/octopusdeploy/push-package-action
| Public | :octocat: GitHub Action to Push a Package to Octopus Deploy
https://github.com/octopusdeploy/push-package-action
cli deployment github-actions octopus-deploy public
Last synced: about 22 hours ago
JSON representation
| Public | :octocat: GitHub Action to Push a Package to Octopus Deploy
- Host: GitHub
- URL: https://github.com/octopusdeploy/push-package-action
- Owner: OctopusDeploy
- License: other
- Created: 2021-03-30T01:49:24.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T02:05:17.000Z (3 months ago)
- Last Synced: 2024-10-30T04:57:27.717Z (3 months ago)
- Topics: cli, deployment, github-actions, octopus-deploy, public
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/push-package-to-octopus-deploy
- Size: 2.73 MB
- Stars: 33
- Watchers: 17
- Forks: 5
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# push-package-action
This is a GitHub Action to push a package to [Octopus Deploy](https://octopus.com/).
## Examples
Incorporate the following actions in your workflow to push a package to Octopus Deploy using an API key, a target instance (i.e. `server`), and a project:
```yml
steps:
- uses: actions/checkout@v3
- name: Push a package to Octopus Deploy 🐙
uses: OctopusDeploy/push-package-action@v3
env:
OCTOPUS_URL: ${{ secrets.SERVER }}
OCTOPUS_API_KEY: ${{ secrets.API_KEY }}
OCTOPUS_SPACE: 'Default'
with:
packages: |
package1.tar.gz
package2.zip
packages/**/*.zip
```
## 📥 Environment Variables
| Name | Description |
| :---------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- |
| `OCTOPUS_URL` | The base URL hosting Octopus Deploy (i.e. `https://octopus.example.com`). It is strongly recommended that this value retrieved from a GitHub secret. |
| `OCTOPUS_API_KEY` | The API key used to access Octopus Deploy. It is strongly recommended that this value retrieved from a GitHub secret. |
| `OCTOPUS_SPACE` | The Name of a space within which this command will be executed. |
## 📥 Inputs
| Name | Description |
| :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `packages` | **Required.** A multi-line and/or comma-delimited list of packages to push to Octopus Deploy (i.e. package1,package2). |
| `overwrite_mode` | Determines the action to perform with package if it already exists in the repository. Valid input values are `FailIfExists` (default), `OverwriteExisting`, and `IgnoreIfExists`. |
| `server` | The instance URL hosting Octopus Deploy (i.e. "https://octopus.example.com/"). The instance URL is required, but you may also use the OCTOPUS_URL environment variable. |
| `api_key` | The API key used to access Octopus Deploy. An API key is required, but you may also use the OCTOPUS_API_KEY environment variable. It is strongly recommended that this value retrieved from a GitHub secret. |
| `space` | The name of a space within which this command will be executed. The space name is required, but you may also use the OCTOPUS_SPACE environment variable. |
## 🤝 Contributions
Contributions are welcome! :heart: Please read our [Contributing Guide](CONTRIBUTING.md) for information about how to get involved in this project.