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

fix(core): show target description, add metadata to schema, and docum… #27131

Merged
merged 1 commit into from
Jul 31, 2024

Conversation

FrozenPandaz
Copy link
Collaborator

@FrozenPandaz FrozenPandaz commented Jul 25, 2024

…ent it

Current Behavior

Target description is not shown in the PDV.

Also, being able to set a description in project.json is not in the schema nor is it documented.

Expected Behavior

Target descriptions are shown in the PDV.

Also, being able to set a description in project.json is in the schema and documented on https://nx-dev-git-metadata-docs-nrwl.vercel.app/project-configuration#target-metadata

image

Related Issue(s)

Fixes #19355

Copy link

vercel bot commented Jul 25, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nx-dev ✅ Ready (Inspect) Visit Preview Jul 25, 2024 9:11pm

@FrozenPandaz FrozenPandaz merged commit 381efa8 into master Jul 31, 2024
6 checks passed
@FrozenPandaz FrozenPandaz deleted the metadata-docs branch July 31, 2024 15:45
FrozenPandaz added a commit that referenced this pull request Aug 1, 2024
#27131)

…ent it

<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->

Target description is not shown in the PDV.

Also, being able to set a description in `project.json` is not in the
schema nor is it documented.

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

Target descriptions are shown in the PDV.

Also, being able to set a description in `project.json` is in the schema
and documented on
https://nx-dev-git-metadata-docs-nrwl.vercel.app/project-configuration#target-metadata

![image](https://github.com/user-attachments/assets/2037eca8-d516-4513-81fd-12b8384a9411)

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #19355

(cherry picked from commit 381efa8)
Copy link

github-actions bot commented Aug 6, 2024

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Target Descriptions
3 participants