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

Remove Node/NPM distribution infrastructure for now #64

Closed
5 tasks done
KCarlile opened this issue Jul 10, 2024 · 0 comments
Closed
5 tasks done

Remove Node/NPM distribution infrastructure for now #64

KCarlile opened this issue Jul 10, 2024 · 0 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation tech debt

Comments

@KCarlile
Copy link
Owner

KCarlile commented Jul 10, 2024

Background

NPM package building and publishing isn't working correctly, so it should be removed for now as fixing it is proving more difficult than it's worth at this point.

.github/workflows/release-package.yml seems to be working, but following the instructions on published packages page results in errors that the package cannot be found.

There may be remnants of Node left even after this ticket is completed as there are two aspects of Node/NPM: package building and package distribution. Distribution is what is broken, so package building Node code may be left behind.

Acceptance Criteria

  • NPM functionality is disabled
    • Node package building functionality may be left in place (i.e., there may be reason to leave package.json and other NPM-related files in place for building and code aggregation/minification reasons)
  • NPM references in documentation and examples have been removed
  • Any other references to Node/NPM are removed from user-facing content
  • NPM packages are deleted from GitHub
  • A follow-up ticket exists to re-add this functionality (working) at a later date

Approach

  • Disable .github/workflows/release-package.yml and add a comment that it has been disabled
    • ...but don't remove it as it may be used later
  • Update documentation and examples to remove references to Node packages
  • Check for other references
  • Clean up anything else related to Node/NPM

Notes

$ git show --name-only ca161b1b
commit ca161b1b6a77d6e820fb9aae7f3c6ff54e94b528 (HEAD -> 64-remove-npm, origin/64-remove-npm)
Author: Kenny Carlile <[email protected]>
Date:   Thu Jul 25 21:25:35 2024 -0700

    Removing Node/NPM distribution code and docs

.github/workflows/release-package.yml
.npmrc
docs/api-docs.md
docs/code-owner-docs.md
docs/examples/index.html
docs/examples/js/guitar-diagrams-js/guitar-diagrams-config.mjs
docs/examples/js/guitar-diagrams-js/guitar-diagrams-marker.mjs
docs/examples/js/guitar-diagrams-js/guitar-diagrams.mjs
docs/index.md
package-lock.json
package.json
src/guitar-diagrams-config.mjs
src/guitar-diagrams-marker.mjs
src/guitar-diagrams.mjs

...and also README.md in this commit.

@KCarlile KCarlile added bug Something isn't working documentation Improvements or additions to documentation tech debt labels Jul 10, 2024
@KCarlile KCarlile self-assigned this Jul 10, 2024
@KCarlile KCarlile moved this from Backlog to Ready in Guitar Diagrams JS Jul 10, 2024
@KCarlile KCarlile moved this from Ready to In progress in Guitar Diagrams JS Jul 10, 2024
@KCarlile KCarlile moved this from In progress to In review in Guitar Diagrams JS Jul 26, 2024
@KCarlile KCarlile changed the title Remove Node/NPM infrastructure for now Remove Node/NPM distribution infrastructure for now Jul 26, 2024
@KCarlile KCarlile moved this from In review to Done in Guitar Diagrams JS Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation tech debt
Projects
Status: Done
Development

No branches or pull requests

1 participant