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.

Sign up for GitHub

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

Jump to bottom

Added workflow to update current-version-tag in readme.md #1080

Closed
wants to merge 17 commits into from
Closed

Added workflow to update current-version-tag in readme.md #1080

wants to merge 17 commits into from

Conversation

thebadcoder96
Copy link

Related to Issue #972

I have changed the hyperlink URL in the readme file and also added a new workflow that will update the link to the live version of the package.

@thebadcoder96 thebadcoder96 requested a review from a team as a code owner January 9, 2024 18:33
@thebadcoder96 thebadcoder96 mentioned this pull request Jan 9, 2024
Open
@taylorfturner taylorfturner added Bug Something isn't working Documentation Improvements or additions to documentation labels Jan 9, 2024
taylorfturner
taylorfturner reviewed Jan 9, 2024
View reviewed changes
Copy link
Contributor

@taylorfturner taylorfturner left a comment

Choose a reason for hiding this comment

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

Only other comment is validation prior to merge to main... maybe change the workflow .yml file to your fork's branch for the time being and just validate

.github/workflows/update-current-version.yml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@thebadcoder96
Copy link
Author

I am having issues with validating. I changed the .yml to my branch but I am getting an error fatal: No names found, cannot describe anything.

Quick googling leads me to believe that this usually means no tags are found. I am a bit confused about how tags work to understand why this is happening.

I read that this might have something to do with the git clone being shallow. Possible solution could be to add this to the .yml file before the git describe --tags line.

- run: git fetch --prune --unshallow

I have no idea what that means. Please advise

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ thebadcoder96
❌ actions-user
You have signed the CLA already but the status is still pending? Let us recheck it.

@thebadcoder96
Copy link
Author

thebadcoder96 commented Jan 10, 2024 •
edited
Loading

I updated the .yml file to fix the issue I mentioned earlier. And it passed the validation; the github action-user committed to change the readme file to my branches tag.

Please review. (Sorry for so many commits I was testing on my branch)

taylorfturner
taylorfturner reviewed Jan 10, 2024
View reviewed changes
README.md Outdated
@@ -418,7 +418,7 @@ json_data = Data('https://github.com/capitalone/DataProfiler/blob/main/dataprofi
```

If the file type is not automatically identified (rare), you can specify them
specifically, see section [Specifying a Filetype or Delimiter](https://capitalone.github.io/DataProfiler/docs/<workflow_to_replace_with_live_version_tag>/html/profiler.html?#specifying-a-filetype-or-delimiter).
specifically, see section [Specifying a Filetype or Delimiter](https://capitalone.github.io/DataProfiler/docs/v0.1.0/html/profiler.html?#specifying-a-filetype-or-delimiter).
Copy link
Contributor

Choose a reason for hiding this comment

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

how did you get v0.1.0 ... should be 0.10.7, but that could be because your fork didn't copy over tags maybe? 🤔

Copy link
Contributor

Choose a reason for hiding this comment

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

actually this is pulling the first version not 0.10.7...

Copy link
Author

@thebadcoder96 thebadcoder96 Jan 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

oh no, I was just messing around with tags and I gave my forked branch a new tag called v0.1.0. There is no tag like that in the original repo.

@thebadcoder96
Copy link
Author

The current logic I have used is pulling the latest tag from the latest commit across all branches which is not what we want. We want it to be the latest tag from the latest commit within one branch. I have updated the .yml for that and also tested it on my forked dev and dynamiclink branches. I also have updated the GitHub actions commit username to my email so it is CLA complaint.

I am closing this PR and will open a new one with the updated changes so it is CLA complaint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@taylorfturner taylorfturner taylorfturner left review comments

@tyfarnan tyfarnan Awaiting requested review from tyfarnan

@micdavis micdavis Awaiting requested review from micdavis

@ksneab7 ksneab7 Awaiting requested review from ksneab7

Assignees

@thebadcoder96 thebadcoder96

Labels
0.10.9 Bug Something isn't working Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@thebadcoder96 @CLAassistant @taylorfturner @actions-user