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

HOFF 701 Update HOF Guide #21

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

TemitopeAyokuHO
Copy link

What

HOFF-701 Update HOF Guide

How

  • added few lines to explain on how to publish a beta version in NPM
  • modified the publishing-hof-npm.md file

- added few lines to explain on how to publish a beta version in NPM
- modified the publishing-hof-npm.md file
@@ -12,6 +12,19 @@ Sometimes a developer may need to upgrade the HOF framework as an improvement or
For the correct permissions ensure you are a member of hof organisation on https://www.npmjs.com/.
You may also need to login to the terminal with your npm credentials before being able to publish.

step 1 : npm login
it will request for your username and password .
step 2 : if you have a 403 forbidden message, copy this link and replace <username> with your username https://registry.npmmirror.com/-/user/org.couchdb.user:<username>.
Copy link
Contributor

Choose a reason for hiding this comment

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

can you explain what step 2 is doing please?

it seems like it will fix the 403 forbidden message, but with my username it looks like it just returns this in a web page
{ "_id": "org.couchdb.user:<myusername>", "name": "<myusername>" }

Copy link
Author

Choose a reason for hiding this comment

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

Yes it will fix the 403 page and return a payload which i believe authorise the login details . i had this issues then reading via the terminal while login that url was generated with my username . It has much to do with Authorization

Copy link
Contributor

Choose a reason for hiding this comment

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

So did you have to run step 2 and then try step 1 again before it worked?

## How to deploy a beta version
After we have implemented our new feature the first thing we do is to bump the version as we would also do for a regular release.

It is crucial that we add <name-of-feature>-beta.0 at the end of your version. The .0 indicates which beta version it is. When we publish a new fix as beta, we will increment the .0 to .1 and so on.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would change name-of-feature to name-of-version-and-feature to make it clear to add what the version is going to be as well.

Comment on lines +18 to +27

## How to deploy a beta version
After we have implemented our new feature the first thing we do is to bump the version as we would also do for a regular release.

It is crucial that we add <name-of-feature>-beta.0 at the end of your version. The .0 indicates which beta version it is. When we publish a new fix as beta, we will increment the .0 to .1 and so on.

So our version should, for example, look like this: 20.4.0-notify-upgrade-8.0.0-beta.0.

commit all changes and it is a good practise to always add a git tag to the beta version
- example: git tag 20.4.0-notify-upgrade-8.0.0-beta.0
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you also add some information on how we actually publish the beta version and how to ensure that it is a beta version that is published so that it does not override the stable latest version?

Copy link
Contributor

@Rhodine-orleans-lindsay Rhodine-orleans-lindsay left a comment

Choose a reason for hiding this comment

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

See other comments above.
You could also put your 2 commit bullet points together so that you just have
- added few lines to the publishing-hof-npm.md file to explain how to publish a beta version in NPM

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.

3 participants