Skip to content

Commit

Permalink
docs: added documentaion for the two actions moved
Browse files Browse the repository at this point in the history
Basic documentation for the two actions.
Needs to be improved.

Refs: AAE-17459
  • Loading branch information
gicappa committed Oct 25, 2023
1 parent e9adfb4 commit dfe2536
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ Here follows the list of GitHub Actions topics available in the current document
- [automate-dependabot](#automate-dependabot)
- [automate-propagation](#automate-propagation)
- [configure-git-author](#configure-git-author)
- [docker-build-image](#docker-build-image)
- [docker-dump-containers-logs](#docker-dump-containers-logs)
- [docker-scan-image-dirs](#docker-scan-image-dirs)
- [env-load-from-yaml](#env-load-from-yaml)
- [free-hosted-runner-disk-space](#free-hosted-runner-disk-space)
- [get-branch-name](#get-branch-name)
Expand Down Expand Up @@ -344,6 +346,12 @@ Configures the git username and email to associate commits with the provided ide

The two vars in the previous snippet are [workflow configuration variables](https://github.blog/changelog/2023-01-10-github-actions-support-for-configuration-variables-in-workflows/) that can be created at organization level and shared across different repositories.

### docker-build-image

```yaml
- uses: Alfresco/alfresco-build-tools/.github/actions/docker-build-image@ref
```

### docker-dump-containers-logs

Dumps Docker containers logs. Each container's log will be stored in a separate `<container_name>.log` file. All files will be archived by default under `containers-logs-<job_id>-<job_retry_number>-<timestamp>.tar.gz` and will be available to download via the workflow's summary page.
Expand All @@ -353,6 +361,12 @@ It is also possible to specify the output archive name when providing the `outpu
- uses: Alfresco/alfresco-build-tools/.github/actions/docker-dump-containers-logs@ref
```

### docker-scan-image-dirs

```yaml
- uses: Alfresco/alfresco-build-tools/.github/actions/docker-scan-image-dirs@ref
```

### env-load-from-yaml

To ease the migration to GitHub Actions of repositories that contains one or
Expand Down

0 comments on commit dfe2536

Please sign in to comment.