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

feat!: [BITSDN-3201] dogfood shared-workflows #11

Closed
wants to merge 5 commits into from

Conversation

lbenezriravin
Copy link
Contributor

@lbenezriravin lbenezriravin commented Oct 4, 2023

@lbenezriravin lbenezriravin force-pushed the lihu/BITSDN-3201 branch 3 times, most recently from a9ddd45 to f2304c1 Compare October 4, 2023 14:44
@coreone
Copy link
Member

coreone commented Oct 20, 2023

I like a lot of these changes. I made some changes while you were out, so this will have to be rebased, etc. I added a bunch of documentation to the README, so the names in there will have to be lined up with the new names you used for all the workflows.

@lbenezriravin lbenezriravin changed the title DNM test feat!: [BITSDN-3201] dogfood shared-workflows Nov 15, 2023
Checking out the repository is not necessary for the
conventional-commits checker action, as evidenced by this repo's own
workflow. Reading the code, it reaches out directly to github.

Reading the code, the code is also *terrible*. Clunky, inflexible,
hacked-together, and barely maintained. I'd like to get off this
third-party dependency ASAP.
Commented-out code should not be committed to main, as it undermines the
whole purpose of using version control.
@lbenezriravin lbenezriravin marked this pull request as ready for review November 15, 2023 19:27
@lbenezriravin lbenezriravin requested a review from a team as a code owner November 15, 2023 19:27
@lbenezriravin lbenezriravin force-pushed the lihu/BITSDN-3201 branch 2 times, most recently from c64ccf0 to 14dbb87 Compare November 15, 2023 19:33
@lbenezriravin lbenezriravin marked this pull request as draft November 15, 2023 19:38
@lbenezriravin lbenezriravin marked this pull request as ready for review November 15, 2023 20:11
@lbenezriravin lbenezriravin force-pushed the lihu/BITSDN-3201 branch 6 times, most recently from 426056f to e715234 Compare November 15, 2023 21:00
Rename the workflows to more consistently reflect what they do. More
importantly, namespace them because github reusable workflows must all
be in the same top-level directory.

* If a workflow simply vendorizes a third-party tool with certain
  values/boilerplate hardcoded, it is named the same as the tool.
* Otherwise, the naming scheme is `<namespace>-[test-]<verb>`. "test-" is
  pulled out to the front both to distinguish it from unit tests and as
  an obvious marker that this workflow should probably be refactored.
Reading the plaintext docs is difficult with long lines. I'd like to
remove the line length exception from the default markdownling config,
but that's not in scope for this PR.

Also, single space after a period is the recommendation from nearly all
major style guides.
Pull the existing action out of local-checks to its own workflow for
re-use/expansion later.
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.

2 participants