Skip to content

Commit

Permalink
Made diagnostic artifact name configurable
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Rosenberg committed Mar 1, 2022
1 parent 83cbd82 commit 5f50eb8
Show file tree
Hide file tree
Showing 7 changed files with 10,240 additions and 23,598 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/test.yml
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Test2
name: Test

on:
push:
Expand Down Expand Up @@ -48,6 +48,7 @@ jobs:
git-username: DimitriusWoodward # Bogus
git-password: tMfxyRCtnulUxXZl # Bogus
stack-name: ${{ needs.setup_job.outputs.stack-name }}
diag-artifact-name: orgflow_diag_${{ matrix.image }}_${{ github.run_attempt }}
env:
ORGFLOW_ACCEPTEULA: "true"
- name: Print outputs
Expand Down
37 changes: 19 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,23 +37,24 @@ Git version 2.25 or later is required. When running on GitHub-hosted runners or

## Inputs

| Name | Required? | Default | Description |
| --------------------- | :-------: | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `version` | | | Version of OrgFlow to install. Can be specified as major '1', minor '1.1' or patch '1.1.1'; latest matching version will be installed (omit to install latest available version). |
| `include-prerelease` | | `"false"` | Set to 'true' to include prerelease versions when determining latest available version. |
| `skip-install` | | `"false"` | Don't download and install OrgFlow (i.e. assume OrgFlow is already installed). |
| `license-key` | **Yes** | | Your OrgFlow license key (you can get one at https://www.orgflow.io/trial if you do not already have one). |
| `salesforce-username` | | | Save username for connecting to production Salesforce org (stored on runner in encrypted form). |
| `salesforce-password` | | | Save password for connecting to production Salesforce org (stored on runner in encrypted form). |
| `git-username` | | | Save username for connecting to remote Git repository (not needed if connecting to a GitHub repository). |
| `git-password` | | | Save access token or password for connecting to remote Git repository (use `secrets.GITHUB_TOKEN` if connecting to the current repository). |
| `git-committer-name` | | `"OrgFlow Default Committer"` | Set name to use in committer signature when committing changes to Git repository. |
| `git-committer-email` | | `"defaultcommitter@orgflow.io"` | Set email address to use in committer signature when committing changes to Git repository. |
| `stack-name` | | | Name of OrgFlow stack to save credentials for (required when saving Salesforce or Git credentials). |
| `encryption-key` | | | Encryption key to use when encrypting and decrypting Salesforce and/or Git credentials (omit to generate a new encryption key). |
| `log-file-name` | | `"{C}-{T:yyyyMMdd-HHmmss-FFF}.log"` | Name (optionally tokenized) of OrgFlow diagnostic log files. |
| `log-level` | | `"verbose"` | Verbosity level for OrgFlow diagnostic log files (verbose, debug, information, warning, error or fatal). |
| `upload-artifact` | | `"true"` | Set to 'false' to disable uploading of all OrgFlow diagnostic log files and bundles during post-job processing. |
| Name | Required? | Default | Description |
| ---------------------- | :-------: | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `version` | | | Version of OrgFlow to install. Can be specified as major '1', minor '1.1' or patch '1.1.1'; latest matching version will be installed (omit to install latest available version). |
| `include-prerelease` | | `false` | Set to 'true' to include prerelease versions when determining latest available version. |
| `skip-install` | | `false` | Don't download and install OrgFlow (i.e. assume OrgFlow is already installed). |
| `license-key` | **Yes** | | Your OrgFlow license key (you can get one at https://www.orgflow.io/trial if you do not already have one). |
| `salesforce-username` | | | Save username for connecting to production Salesforce org (stored on runner in encrypted form). |
| `salesforce-password` | | | Save password for connecting to production Salesforce org (stored on runner in encrypted form). |
| `git-username` | | | Save username for connecting to remote Git repository (not needed if connecting to a GitHub repository). |
| `git-password` | | | Save access token or password for connecting to remote Git repository (use `secrets.GITHUB_TOKEN` if connecting to the current repository). |
| `git-committer-name` | | `OrgFlow Default Committer` | Set name to use in committer signature when committing changes to Git repository. |
| `git-committer-email` | | `defaultcommitter@orgflow.io` | Set email address to use in committer signature when committing changes to Git repository. |
| `stack-name` | | | Name of OrgFlow stack to save credentials for (required when saving Salesforce or Git credentials). |
| `encryption-key` | | | Encryption key to use when encrypting and decrypting Salesforce and/or Git credentials (omit to generate a new encryption key). |
| `log-file-name` | | `{C}-{T:yyyyMMdd-HHmmss-FFF}.log` | Name (optionally tokenized) of OrgFlow diagnostic log files. |
| `log-level` | | `verbose` | Verbosity level for OrgFlow diagnostic log files (verbose, debug, information, warning, error or fatal). |
| `upload-diag-artifact` | | `true` | Set to 'false' to disable uploading of all OrgFlow diagnostic log files and bundles during post-job processing. |
| `diag-artifact-name` | | `orgflow_diag_${{ github.job }}_${{ github.run_attempt }}` | Name to use for the artifact when uploading OrgFlow diagnostic log files and bundles. |

## Outputs

Expand Down Expand Up @@ -231,4 +232,4 @@ This action enables and configures OrgFlow diagnostic logging, both for this act

You can override the naming of diagnostic log files using the `log-file-name` and `log-level` inputs. The `log-file-name` input supports several tokens you can use to base log file names on values only known at runtime. Please refer to the [logging section in our documentation](https://docs.orgflow.io/troubleshooting/logging.html) for more information about specifying log file names and log level.

This action also contains a post-job step that collects all OrgFlow diagnostic log files and bundles written throughout your whole job, and uploads them as an artifact on your workflow run named `OrgFlowDiagnostics`. This can be very useful during troubleshooting. If you wish to opt out of this behavior for any reason, you can do so by specifying `upload-artifact: "false"` as an input to this action.
This action also contains a post-job step that collects all OrgFlow diagnostic log files and bundles written throughout your whole job, and uploads them as an artifact on your workflow run named `orgflow_diag_<job>_<attempt>`. This can be very useful during troubleshooting. You can change the artifact name using the input `diag-artifact-name`. If you wish to disable the uploading of this artifact for any reason, you can do so by specifying `upload-diag-artifact: "false"` as an input to this action.
6 changes: 5 additions & 1 deletion action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,14 @@ inputs:
description: Verbosity level for OrgFlow diagnostic log files (verbose, debug, information, warning, error or fatal).
required: false
default: verbose
upload-artifact:
upload-diag-artifact:
description: Set to 'false' to disable uploading of all OrgFlow diagnostic log files and bundles during post-job processing.
required: false
default: "true"
diag-artifact-name:
description: Name to use for the artifact when uploading OrgFlow diagnostic log files and bundles.
required: false
default: orgflow_diag_${{ github.job }}_${{ github.run_attempt }}
outputs:
version:
description: Exact version of OrgFlow that was installed and/or configured.
Expand Down
Loading

0 comments on commit 5f50eb8

Please sign in to comment.