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

🛠 Tooling: Repository might not need to pnpm build || true in lint-knip.yml #1087

Closed
3 tasks done
JoshuaKGoldberg opened this issue Dec 11, 2023 · 1 comment · Fixed by #1152
Closed
3 tasks done

🛠 Tooling: Repository might not need to pnpm build || true in lint-knip.yml #1087

JoshuaKGoldberg opened this issue Dec 11, 2023 · 1 comment · Fixed by #1152
Assignees
@JoshuaKGoldberg
Labels
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! type: cleanup Tech debt or other code/repository cleanups

Comments

@JoshuaKGoldberg
Copy link
Owner

JoshuaKGoldberg commented Dec 11, 2023 •
edited
Loading

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Overview

Thanks to #1048, we see now that this repository has two bits of tooling that are different between its 🍎 actual files and 🍌 code templates (see Additional Info below for explanation of the emojis):

I'd added pnpm build || true in lint-knip.yml back in #553. It might have been necessary then, but doesn't seem necessary now? If I rm -rf lib locally then run pnpm lint:knip, nothing fails.

I think this should be a straightforward fix of removing the pnpm build || true. That might fail in PR though, so not marking as good first issue. Maybe, good second issue would be more accurate? Welcoming PRs from anybody who's feeling confident and/or has already completed an issue! 🙂

Additional Info

This repository is two things:

  • 🍎 An example of a working TypeScript repository, including builds, Knip, package publishing, and more tooling
  • 🍌 Code that can set up a new or existing repository using all of that repository tooling

For the most part, the repository's end-to-end test for --mode migration makes sure that the 🍎 actual files and 🍌 code templates stay the same. As in, if one changes, the other needs to have the same change as well. But per #546, there are some files that were missed in that test. We're only now able to verify that they're the same as of #1048. That PR is where this discrepancy was discovered.
@JoshuaKGoldberg JoshuaKGoldberg added type: bug Something isn't working :( area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! labels Dec 11, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Dec 11, 2023
Merged
3 tasks
@JoshuaKGoldberg JoshuaKGoldberg added type: cleanup Tech debt or other code/repository cleanups and removed type: bug Something isn't working :( labels Dec 11, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Dec 30, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Dec 30, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Dec 30, 2023
@JoshuaKGoldberg
fix: normalize whether build happens before lint/knip (#1152)
01704e9 
## PR Checklist

- [x] Addresses an existing open issue: fixes #1087
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

Finally makes it so a `pnpm build || exit 0` only happens if `bin` is
specified. This is because:
* `n/no-missing-import` will complain if the referenced `.js` file
doesn't exist
* The only way for that file to exist is to `build`
* But, building failing -especially in migrating an existing repo-
shouldn't prevent the rest of the commands from running
@github-actions GitHub Actions
Copy link

🎉 This is included in version v1.51.2 🎉

The release is available on:

Cheers! 📦🚀

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

@JoshuaKGoldberg JoshuaKGoldberg

Labels
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! type: cleanup Tech debt or other code/repository cleanups
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: normalize whether build happens before lint/knip JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg