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

updated git metadata docs page based on akit docs #2366

Merged
merged 9 commits into from
Jan 5, 2024

Conversation

Lewis-Seiden
Copy link
Contributor

No description provided.

rzblue
rzblue previously requested changes Oct 26, 2023
Copy link
Member

@rzblue rzblue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs some formatting changes and clarifications

This should also include an example of the generated class and how to use it

@sciencewhiz
Copy link
Collaborator

Does this address #2182?

@rzblue rzblue linked an issue Oct 28, 2023 that may be closed by this pull request
The ``--abbrev-ref`` flag tells Git to use a short version of the name for the current commit that ``rev-parse`` is acting on. When HEAD is the most recent commit on a branch, this will return the name of that branch.

Next, create a new task in the ``build.gradle`` file that will run the above Git command and write it to a file in the ``src/main/deploy`` directory. For example, the following is an example task named ``writeBranchName`` that will write the branch name to a file named ``branch.txt``.
To install gversion add the following line to the plugins block of ``build.gradle``. This tells Gradle to use gversion in the project.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Punctuation needs to be added here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what punctuation is missing?

Copy link
Member

@Starlight220 Starlight220 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this behave if the project isn't stored in git?

@Lewis-Seiden
Copy link
Contributor Author

How does this behave if the project isn't stored in git?

it generates BuildConstants.java with most fields set to a "not found" or default value

@jasondaming
Copy link
Member

It looks good enough to me but I am not the grammar....expert.

@Daltz333 Daltz333 merged commit 57731c9 into wpilibsuite:main Jan 5, 2024
9 checks passed
@Lewis-Seiden Lewis-Seiden deleted the git-metadata-update branch January 6, 2024 02:57
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.

Fix Git Data in Deploy not being correct
6 participants