Skip to content

Add required open source project files #43

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

Merged
merged 1 commit into from
Apr 29, 2025
Merged

Conversation

mssalemi
Copy link
Contributor

@mssalemi mssalemi commented Apr 22, 2025

Addresses: https://github.com/shop/issues-shopifyvm/issues/235

Followed section 2.5 in vault docs for making a repo public, this PR adds the following suggested files for making a repository public at Shopify:

Done

  • Add required files:
    • add README.md
    • add CONTRIBUTING.md -> I didn't see requirements for this in the docs
    • add CODE_OF_CONDUCT.md file -> same as function-runner
    • add License.md -> copied from vault
    • add CLA workflow -> copied from vault

WIP

  • Documentation
    • Ensure README.md is comprehensive (2.8)

[TODO] before making repo public

@mssalemi mssalemi changed the title Add github CLA Add required open source project files Apr 23, 2025
@mssalemi mssalemi force-pushed the ms.make-repo-public branch from cd31edf to 8674184 Compare April 24, 2025 15:40
@mssalemi mssalemi marked this pull request as ready for review April 28, 2025 13:31
@caution-tape-bot
Copy link

👋 It seems that this PR is adding, or editing, a GitHub Action workflow that is not configured to use our custom GitHub Action runners.

For private repositories, the only supported way of running Action workflows is via the custom runners. You can learn more about the supported use cases in our GitHub Actions documentation.

To make sure that your workflow is using these runners you need to add the shopify-ubuntu-latest label to your workflow manifest file, or shopify-core-ubuntu-latest for Core repositories:

runs-on: shopify-ubuntu-latest

If your repository is intended to become Public later, please use runs-on: shopify-ubuntu-latest for now. The custom runners should function the same as ubuntu-latest public runners, though the exact Ubuntu version may vary. Please see the section below for more information about OS selection on premium runners.

If you run into any issues with the custom runners, please reach out in help-eng-infrastructure on Discourse.

Note for OS Versions

The shopify-ubuntu-latest runners can select from two different runner pools, which contain both Ubuntu 20.04 and Ubuntu 22.04 machines. For some workflows, this can cause issues.

To use Ubuntu 20.04 only, you can specify runs-on: shopify-ubuntu-20.04.

To use Ubuntu 22.04 only, you can specify runs-on: shopify-ubuntu-latest-2.


This comment was added by the GitHubActions::Workflow Caution Tape Bot rule.
View the source of this rule in Services DB

@mssalemi mssalemi force-pushed the ms.make-repo-public branch from 6f8d1c8 to 1160d30 Compare April 28, 2025 20:05
@adampetro
Copy link
Contributor

Let's squash down the commits before merging

@mssalemi mssalemi force-pushed the ms.make-repo-public branch from 0a84dc7 to b60e6bd Compare April 28, 2025 20:38
@mssalemi
Copy link
Contributor Author

Will merge this and go through the action items listed above this afternoon.

@mssalemi mssalemi merged commit 34c4927 into main Apr 29, 2025
3 checks passed
@mssalemi mssalemi deleted the ms.make-repo-public branch April 29, 2025 18:13
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