@@ -40,7 +40,7 @@ The following options can be used to limit which actions are allowed in converte
|
||||
- `--allow-github-created-actions` specifies that actions published from the `github` or `actions` organizations are allowed.
|
||||
|
||||
For example, such actions include `github/super-linter` and `actions/checkout`.
|
||||
|
||||
|
||||
This option is equivalent to `--allowed-actions actions/* github/*`.
|
||||
|
||||
### Using a credentials file for authentication
|
||||
@@ -84,7 +84,7 @@ Supported values for `provider` are:
|
||||
- `bitbucket_server`
|
||||
- `azure_devops`
|
||||
|
||||
### Restricting {% data variables.product.prodname_actions %} features to include in workflows
|
||||
### Controlling optional features
|
||||
|
||||
You can use the `--features` option to limit the features used in workflows that {% data variables.product.prodname_actions_importer %} creates. This is useful for excluding newer {% data variables.product.prodname_actions %} syntax from workflows when migrating to an older {% data variables.product.prodname_ghe_server %} instance. When using the `--features` option, you must specify the version of {% data variables.product.prodname_ghe_server %} that you are migrating to.
|
||||
|
||||
@@ -100,6 +100,59 @@ The supported values for `--features` are:
|
||||
- `ghes-latest`
|
||||
- `ghes-<number>`, where `<number>` is the version of {% data variables.product.prodname_ghe_server %}, `3.0` or later. For example, `ghes-3.3`.
|
||||
|
||||
You can view the list of available feature flags by {% data variables.product.prodname_actions_importer %} by running the `list-features` command. For example:
|
||||
```shell{:copy}
|
||||
gh actions-importer list-features
|
||||
```
|
||||
|
||||
You should see an output similar to the following.
|
||||
|
||||
```
|
||||
Available feature flags:
|
||||
|
||||
actions/cache (disabled):
|
||||
Control usage of actions/cache inside of workflows. Outputs a comment if not enabled.
|
||||
GitHub Enterprise Server >= ghes-3.5 required.
|
||||
|
||||
composite-actions (enabled):
|
||||
Minimizes resulting workflow complexity through the use of composite actions. See https://docs.github.com/en/actions/creating-actions/creating-a-composite-action for more information.
|
||||
GitHub Enterprise Server >= ghes-3.4 required.
|
||||
|
||||
reusable-workflows (disabled):
|
||||
Avoid duplication by re-using existing workflows. See https://docs.github.com/en/actions/using-workflows/reusing-workflows for more information.
|
||||
GitHub Enterprise Server >= ghes-3.4 required.
|
||||
|
||||
workflow-concurrency-option-allowed (enabled):
|
||||
Allows the use of the `concurrency` option in workflows. See https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#concurrency for more information.
|
||||
GitHub Enterprise Server >= ghes-3.2 required.
|
||||
|
||||
Enable features by passing --enable-features feature-1 feature-2
|
||||
Disable features by passing --disable-features feature-1 feature-2
|
||||
```
|
||||
|
||||
To toggle feature flags, you can use either of the following methods:
|
||||
- Use the `--enable-features` and `--disable-features` options when running a `gh actions-importer` command.
|
||||
- Use an environment variable for each feature flag.
|
||||
|
||||
You can use the `--enable-features` and `--disable-features` options to select specific features to enable or disable for the duration of the command.
|
||||
For example, the following command disables use of `actions/cache` and `composite-actions`:
|
||||
|
||||
```bash
|
||||
gh actions-importer dry-run ... --disable-features=composite-actions actions/cache
|
||||
```
|
||||
|
||||
You can use the `configure --features` command to interactively configure feature flags and automatically write them to your environment:
|
||||
|
||||
```bash
|
||||
$ gh actions-importer configure --features
|
||||
|
||||
✔ Which features would you like to configure?: actions/cache, reusable-workflows
|
||||
✔ actions/cache (disabled): Enable
|
||||
? reusable-workflows (disabled):
|
||||
› Enable
|
||||
Disable
|
||||
```
|
||||
|
||||
### Disabling network response caching
|
||||
|
||||
By default, {% data variables.product.prodname_actions_importer %} caches responses from network requests to reduce network load and reduce run time. You can use the `--no-http-cache` option to disable the network cache. For example:
|
||||
|
||||
Reference in New Issue
Block a user