microsoft / publish-dev-container-features-action

GitHub action to publish dev container features

👋 This repo is archived and kept here for historical reference only.

For all current work related to 'dev container features', please check out https://containers.dev or the dev container specification repo.

---

Publish Development container features (GitHub Action)

Used in the dev-container-features-template illlustating an approach to publish custom "devcontainer features" to your GitHub repo.

Additionally, can package dev container "definitions".

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

publish-dev-container-features-action's Issues

NOTICE: Name change `features.*` --> `devcontainer-features.*`

A recent breaking change was introduced to our preview for dev container features.

Everywhere a file had been called features.{tgz, json} is now named devcontainer-features.{tgz, json}.

Codespaces and Remote-Containers has now been updated to expect these names, and the previous names will cause a build error.

Steps to update:

1. Update this line in your local copy of the template to emit the release artifact with the new name
   • dev-container-features-template -> deploy-features.yml#L27
2. Re-release your features on a new tag
   • Using commit b92badd of this action (or newer).

Please note that any older releases prior to this change will no longer work. You'll want to re-run the action on your tag to rebuild the artifacts.

Thanks for experimenting and bearing with us during the feature preview. If you have any further feedback, PLEASE let us know over at the dev-container-spec repo.

Context: microsoft/vscode-remote-release#5980

Participate in design discussions

Please see the various discussions on the dev-container-spec repo on shaping the future of features.

devcontainers/spec#8

Action creates a wrong file

The devcontainer features expect the features tar to be called features.tgz, but this action creates it as devcontainer-features.tgz.

publish-dev-container-features-action/src/utils.ts

Line 26 in b92badd

.create({file: 'devcontainer-features.tgz', C: path, filter}, ['.'])

Moreover, it expects the file inside the tgz to be named features.json, but the action creates it as devcontainer-features.json.

publish-dev-container-features-action/src/utils.ts

Line 35 in b92badd

const p = path.join(pathToFeatureDir, 'devcontainer-features.json')

I can work on a PR to fix the same.