Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize repository layout, update YAML parsing #12

Merged
merged 6 commits into from
Jun 18, 2024

Conversation

nwiltsie
Copy link
Member

Background

I have a number of large changes in the works for this repository, but several existing workflows that call this action refer specifically to uclahs-cds/tool-Docker-action/build-release@main. In order to not break existing workflows while making breaking changes, I've created the new branch refactor-base (currently pointing to main) and am going to target all PRs toward it.

Once I'm done with the breaking changes (several PRs from now), I intend to:

  1. Tag refactor-base (still not merged into main) as v2
  2. Update all calling workflows to use uclahs-cds/tool-Docker-action@v2
  3. Merge refactor-base into main

That should keep things stable, reduce the number of tedious PRs to be made in other repositories, and increase the maintainability of this repository.

Description of this PR

This PR accomplishes a few tasks simultaneously:

  1. Fixes YAML reader update #10 by replacing https://github.com/marketplace/actions/read-yaml with https://github.com/marketplace/actions/yq-portable-yaml-processor
    • This is a breaking change, as the input denoting the key path has a different format
  2. Unpacks the build-release folder, putting the action.yml file in the standard location at the repository's root
    • This is a breaking change.
  3. Makes the docker-token input optional, defaulting to ${docker.token}

I tested these changes with a dummy repository containing a basic Dockerfile - https://github.com/uclahs-cds/docker-internal-tests/actions/runs/9473134167/job/26100013560. This line shows that the workflow ran on commit 5290dd2.

Closes #10

Checklist

  • This PR does NOT contain PHI or germline genetic data. A repo may need to be deleted if such data is uploaded. Disclosing PHI is a major problem.
  • This PR does NOT contain molecular files, compressed files, output files such as images (e.g. .png, .jpeg), .pdf, .RData, .xlsx, .doc, .ppt, or other non-plain-text files. To automatically exclude such files using a .gitignore file, see here for example.
  • I have read the code review guidelines and the code review best practice on GitHub check-list.
  • I have set up or verified the main branch protection rule following the github standards before opening this pull request.
  • The name of the branch is meaningful and well formatted following the standards, using [AD_username (or 5 letters of AD if AD is too long)]-[brief_description_of_branch].
  • I have added the major changes included in this pull request to the CHANGELOG.md under the next release version or unreleased, and updated the date.

@nwiltsie nwiltsie requested a review from a team June 17, 2024 22:21
Copy link
Collaborator

@yashpatel6 yashpatel6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@nwiltsie nwiltsie merged commit 940af99 into refactor-base Jun 18, 2024
5 checks passed
@nwiltsie nwiltsie deleted the nwiltsie-refactor branch June 18, 2024 19:33
@nwiltsie nwiltsie mentioned this pull request Aug 16, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants