opendevstack / opendevstack/ods-quickstarters

Adding .npmrc and package-lock.json to .gitignore

Open
#336 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Shell
Stars
39
Forks
50
PR merge metrics
No merged PRs in 30d

Description

Wrapping up the discussion from our last conversation.

For local development, we can inform developers to set up .npmrc to point to our private nexus instance. We can add this to README. At the moment, this information is missing for angular and ionic quickstarters.
For deployment, we don't need the users to submit the nexus host info as node10-12 Jenkins agents already have the npm configuration baked into them. So that section in angular and ionic quickstarters can be removed.
We just need to inform the users why its important not to push package-lock.json file as it will override and switch our private registry to global one.
Thoughts? @cschweikert @ManuelFeller @rianet @michaelsauter

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README linked under be-typescript-express/files, the Angular and Ionic quickstarter documentation, and fe-angular/Jenkinsfile.template around line 21. Check the related .gitignore files and existing Nexus guidance. Done means the local npm setup and package-lock.json warning are documented, deployment no longer asks users for Nexus host information, and the requested ignore entries are present.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, node.js, typescript
Domain
build-system, devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.