From ece29cb38e2d5b931af8955a41a8d3d9bc4e626a Mon Sep 17 00:00:00 2001 From: jarrodcolburn Date: Fri, 10 Mar 2023 00:22:42 -0600 Subject: [PATCH 1/5] Warn: Allow GH acions create PRs --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d674465f..4f05578ef 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,11 @@ Features are individually versioned by the `version` attribute in a Feature's `d Features are meant to be easily sharable units of dev container configuration and installation code. -This repo contains a GitHub Action [workflow](.github/workflows/release.yaml) that will publish each feature to GHCR. By default, each Feature will be prefixed with the `` namespace. For example, the two Features in this repository can be referenced in a `devcontainer.json` with: +This repo contains a GitHub Action [workflow](.github/workflows/release.yaml) that will publish each feature to GHCR. + +The default Action auto generates a README.md about feature (mergining in NOTES.md if one exists) and commits it to repo. **Allow GitHub Actions to create and approve pull requests** should be enabled in the repo's Settings > Actions > General > Workflow permissions. + +By default, each Feature will be prefixed with the `` namespace. For example, the two Features in this repository can be referenced in a `devcontainer.json` with: ``` ghcr.io/devcontainers/feature-starter/color:1 From 8ea54dd14215c25c1978af3529e16d8adedcdb9c Mon Sep 17 00:00:00 2001 From: jarrodcolburn Date: Fri, 10 Mar 2023 11:25:26 -0600 Subject: [PATCH 2/5] Typo: fix, and made more consise/clear --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4f05578ef..859f443db 100644 --- a/README.md +++ b/README.md @@ -119,9 +119,9 @@ Features are individually versioned by the `version` attribute in a Feature's `d Features are meant to be easily sharable units of dev container configuration and installation code. -This repo contains a GitHub Action [workflow](.github/workflows/release.yaml) that will publish each feature to GHCR. +This repo contains a **GitHub Action** [workflow](.github/workflows/release.yaml) that will publish each feature to GHCR. -The default Action auto generates a README.md about feature (mergining in NOTES.md if one exists) and commits it to repo. **Allow GitHub Actions to create and approve pull requests** should be enabled in the repo's Settings > Actions > General > Workflow permissions. +*Allow GitHub Actions to create and approve pull requests* should be enabled in the repo's `Settings > Actions > General > Workflow permissions` for auto generation of `src//README.md` per feature (merging in existing `src//NOTES.md`). By default, each Feature will be prefixed with the `` namespace. For example, the two Features in this repository can be referenced in a `devcontainer.json` with: From 41a9db11e2d44bc3f9cd107530885199c672a250 Mon Sep 17 00:00:00 2001 From: jarrodcolburn Date: Tue, 14 Mar 2023 11:33:18 -0500 Subject: [PATCH 3/5] Update README.md Co-authored-by: Samruddhi Khandale --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 859f443db..0fef8b673 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ Features are individually versioned by the `version` attribute in a Feature's `d Features are meant to be easily sharable units of dev container configuration and installation code. -This repo contains a **GitHub Action** [workflow](.github/workflows/release.yaml) that will publish each feature to GHCR. +This repo contains a **GitHub Action** [workflow](.github/workflows/release.yaml) that will publish each Feature to GHCR. *Allow GitHub Actions to create and approve pull requests* should be enabled in the repo's `Settings > Actions > General > Workflow permissions` for auto generation of `src//README.md` per feature (merging in existing `src//NOTES.md`). From 1cd221cb957791c4e79c9356a31db5fe4fa1f2b7 Mon Sep 17 00:00:00 2001 From: jarrodcolburn Date: Tue, 14 Mar 2023 11:33:32 -0500 Subject: [PATCH 4/5] Update README.md Co-authored-by: Samruddhi Khandale --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0fef8b673..54275579e 100644 --- a/README.md +++ b/README.md @@ -121,7 +121,7 @@ Features are meant to be easily sharable units of dev container configuration an This repo contains a **GitHub Action** [workflow](.github/workflows/release.yaml) that will publish each Feature to GHCR. -*Allow GitHub Actions to create and approve pull requests* should be enabled in the repo's `Settings > Actions > General > Workflow permissions` for auto generation of `src//README.md` per feature (merging in existing `src//NOTES.md`). +*Allow GitHub Actions to create and approve pull requests* should be enabled in the repository's `Settings > Actions > General > Workflow permissions` for auto generation of `src//README.md` per feature (which merges any existing `src//NOTES.md`). By default, each Feature will be prefixed with the `` namespace. For example, the two Features in this repository can be referenced in a `devcontainer.json` with: From d5cfffcc42f2b648a8896cf6c98088c0f7ec2d12 Mon Sep 17 00:00:00 2001 From: Samruddhi Khandale Date: Tue, 14 Mar 2023 11:47:09 -0700 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 54275579e..1a1cea8e6 100644 --- a/README.md +++ b/README.md @@ -121,7 +121,7 @@ Features are meant to be easily sharable units of dev container configuration an This repo contains a **GitHub Action** [workflow](.github/workflows/release.yaml) that will publish each Feature to GHCR. -*Allow GitHub Actions to create and approve pull requests* should be enabled in the repository's `Settings > Actions > General > Workflow permissions` for auto generation of `src//README.md` per feature (which merges any existing `src//NOTES.md`). +*Allow GitHub Actions to create and approve pull requests* should be enabled in the repository's `Settings > Actions > General > Workflow permissions` for auto generation of `src//README.md` per Feature (which merges any existing `src//NOTES.md`). By default, each Feature will be prefixed with the `` namespace. For example, the two Features in this repository can be referenced in a `devcontainer.json` with: