|
1 | 1 | <!-- header:start --> |
| 2 | + |
| 3 | +#  GitHub Action: Deployment - Create Release |
| 4 | + |
| 5 | +<div align="center"> |
| 6 | + <img src="../../../.github/logo.svg" width="60px" align="center" alt="Deployment - Create Release" /> |
| 7 | +</div> |
| 8 | + |
| 9 | +--- |
| 10 | + |
2 | 11 | <!-- header:end --> |
3 | 12 | <!-- badges:start --> |
| 13 | + |
| 14 | +[](https://github.com/marketplace/actions/deployment---create-release) |
| 15 | +[](https://github.com/hoverkraft-tech/ci-github-publish/releases) |
| 16 | +[](http://choosealicense.com/licenses/mit/) |
| 17 | +[](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-publish?style=social) |
| 18 | +[](https://github.com/hoverkraft-tech/ci-github-publish/blob/main/CONTRIBUTING.md) |
| 19 | + |
4 | 20 | <!-- badges:end --> |
5 | 21 | <!-- overview:start --> |
| 22 | + |
| 23 | +## Overview |
| 24 | + |
| 25 | +Action to create a new release |
| 26 | + |
6 | 27 | <!-- overview:end --> |
7 | 28 | <!-- usage:start --> |
| 29 | + |
| 30 | +## Usage |
| 31 | + |
| 32 | +```yaml |
| 33 | +- uses: hoverkraft-tech/ci-github-publish/actions/release/get-configuration@ed864a88ec8610dc2a1b9aab1dbde2864bf75df4 # 0.16.0 |
| 34 | + with: |
| 35 | + # Working directory for monorepo support. |
| 36 | + # If specified, the release configuration file will be placed in `.github/release-configs/{slug}.yml` where slug is derived from the working directory path. |
| 37 | + # The configuration will include `include-paths` to filter pull requests to only those that modified files in the specified directory. |
| 38 | + working-directory: "" |
| 39 | +``` |
| 40 | +
|
8 | 41 | <!-- usage:end --> |
9 | 42 | <!-- inputs:start --> |
| 43 | +
|
| 44 | +## Inputs |
| 45 | +
|
| 46 | +| **Input** | **Description** | **Required** | **Default** | |
| 47 | +| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | |
| 48 | +| **`working-directory`** | Working directory for monorepo support. | **false** | - | |
| 49 | +| | If specified, the release configuration file will be placed in `.github/release-configs/{slug}.yml` where slug is derived from the working directory path. | | | |
| 50 | +| | The configuration will include `include-paths` to filter pull requests to only those that modified files in the specified directory. | | | |
| 51 | + |
10 | 52 | <!-- inputs:end --> |
11 | 53 | <!-- outputs:start --> |
| 54 | + |
| 55 | +## Outputs |
| 56 | + |
| 57 | +| **Output** | **Description** | |
| 58 | +| ----------------------- | ---------------------------------------------------------------------------------- | |
| 59 | +| **`working-directory`** | The working directory used for the release. | |
| 60 | +| | Relative to the repository root. | |
| 61 | +| | Empty if not set. | |
| 62 | +| **`config-slug`** | The slug derived from the working directory. Empty if no working directory is set. | |
| 63 | +| **`config-name`** | The name of the release configuration file | |
| 64 | +| **`config-path`** | The path to the release configuration file | |
| 65 | + |
12 | 66 | <!-- outputs:end --> |
13 | 67 | <!-- secrets:start --> |
14 | 68 | <!-- secrets:end --> |
|
18 | 72 | // jscpd:ignore-start |
19 | 73 | --> |
20 | 74 | <!-- contributing:start --> |
| 75 | + |
| 76 | +## Contributing |
| 77 | + |
| 78 | +Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-publish/blob/main/CONTRIBUTING.md) for more details. |
| 79 | + |
21 | 80 | <!-- contributing:end --> |
22 | 81 | <!-- security:start --> |
23 | 82 | <!-- security:end --> |
24 | 83 | <!-- license:start --> |
| 84 | + |
| 85 | +## License |
| 86 | + |
| 87 | +This project is licensed under the MIT License. |
| 88 | + |
| 89 | +SPDX-License-Identifier: MIT |
| 90 | + |
| 91 | +Copyright © 2025 hoverkraft |
| 92 | + |
| 93 | +For more details, see the [license](http://choosealicense.com/licenses/mit/). |
| 94 | + |
25 | 95 | <!-- license:end --> |
26 | 96 | <!-- generated:start --> |
| 97 | + |
| 98 | +--- |
| 99 | + |
| 100 | +This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor). |
| 101 | + |
27 | 102 | <!-- generated:end --> |
28 | 103 | <!-- |
29 | 104 | // jscpd:ignore-end |
|
0 commit comments