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

keywords is not included in devContainerFeature.schema.json #204

Closed
LosFarmosCTL opened this issue Feb 23, 2023 · 4 comments · Fixed by #402
Closed

keywords is not included in devContainerFeature.schema.json #204

LosFarmosCTL opened this issue Feb 23, 2023 · 4 comments · Fixed by #402

Comments

@LosFarmosCTL
Copy link

The documentation for Features on containers.dev lists keywords as a possible value for the devcontainer-feature.json file. That entry is not included in the schema file though. Is this an error with the documentation and keywords are not actually meant to be included (anymore?), or is this something that's missing from the schema?

@bamurtaugh
Copy link
Member

Thanks for opening this! @joshspicer I think this is just missing from the schema, but please let me know otherwise!

LosFarmosCTL added a commit to LosFarmosCTL/swift-devcontainer-features that referenced this issue Feb 24, 2023
@nifr
Copy link
Contributor

nifr commented Jan 22, 2024

We just got bitten by this issue for the second time in a few months 😢
I ran into it a while ago, then forgot about it or thought it was resolved after ~1 year.

Today we attempted to categorise our private features (100+).
The keywords property is part of the official documentation.

We discussed categories, then added keywords to all our devcontainer-feature.json files.
Now we can't publish our features using the official GitHub Action any more.
The schema validation step fails (enabled by default).

Screenshot 2024-01-22 at 20 45 42

We're now forced to manually revert a large number of (partial) commits.

The workaround - disabling schema validation for the action - is not an option for us.

For anyone facing the same issue, you can disable schema validation in the workflow file:

jobs:
  publish:
     # [..]
      - name: "Publish Features"
        uses: devcontainers/action@v1
        with:
          disable-schema-validation: "true"
          # [..]

@nifr
Copy link
Contributor

nifr commented Jan 22, 2024

I opened PR #402 to address this issue. It adds the missing keywords property to the feature schema.

@bamurtaugh @joshspicer - Feel to review it and have a lovely day 👋

@samruddhikhandale
Copy link
Member

With the new release of @devcontainers/action v1.4.1, this should be fixed, thanks! ✨

@nifr Feel free to reopen if you are still running into this issue!

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 a pull request may close this issue.

4 participants