Skip to content

Readme, package.json, and changesets - #2

Merged
jaredly merged 1 commit into
mainfrom
initial
May 19, 2022
Merged

Readme, package.json, and changesets#2
jaredly merged 1 commit into
mainfrom
initial

Conversation

@jaredly

@jaredly jaredly commented May 18, 2022

Copy link
Copy Markdown
Contributor

Summary:

Setting up this repository! Very excited.

Issue: part of https://khanacademy.atlassian.net/browse/FEI-4550

Test plan:

🚫

Summary:
Setting up this repository! Very excited.

Test plan:
🚫
@jaredly jaredly self-assigned this May 18, 2022
@jaredly
jaredly requested review from jeresig and k4b7 May 18, 2022 21:30
@jaredly jaredly changed the title Readme, package.json, changesets, and README Readme, package.json, and changesets May 18, 2022

@jeresig jeresig left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This looks great! That gitpkg looks extremely cool and exactly what we want!

Could you add Gerald in to and make the github-actions team the default reviewer of all changes to this repo?

@k4b7 k4b7 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is so exciting!

Comment thread README.md

## How does the monorepo work?

Github doesn't support putting actions in subdirectories, so we need to do some fancy work here. Inspired by [gitpkg](https://github.com/ramasilveyra/gitpkg), we "publish" versions of our actions to 'bare tags' in this repo. So the tag `filter-files-v0.0.1` would only contain the files for the `filter-files` action, and thus github is perfectly happy for us to reference it as `uses: @Khan/actions#filter-files-v0.0.1`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sneaky. This should also allow us to not have to check in the build files on main.

Comment thread README.md

Github doesn't support putting actions in subdirectories, so we need to do some fancy work here. Inspired by [gitpkg](https://github.com/ramasilveyra/gitpkg), we "publish" versions of our actions to 'bare tags' in this repo. So the tag `filter-files-v0.0.1` would only contain the files for the `filter-files` action, and thus github is perfectly happy for us to reference it as `uses: @Khan/actions#filter-files-v0.0.1`.

Actions that depend on other actions within this repo (with e.g. `uses: filter-files`) will have the references automatically converted to the appropriated pinned reference (e.g. `Khan/actions#filter-files-v0.0.1`) as part of the publish process.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

That's pretty sneaky. What's responsible for updating these references?

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.

3 participants