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

Created Instructions for Installing Developer Snapshots #185

Merged
merged 3 commits into from
Feb 28, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,68 @@ If you want to customize the icons or the theme, refer to the [customization sec
<script src="https://unpkg.com/buefy/dist/buefy.min.js"></script>
```


### Installing Developer Release(s) from GitHub npm Registry to Access the Latest Features
To incorporate the latest changes from the development branch of buefy-next, you can install developer releases from the GitHub npm registry. However, proceed with caution as these packages may be deleted or retracted without notice.

Steps:
1. Generate a Personal Access Token:

Create a personal access token on GitHub with read access to the GitHub Packages registry.

2. Configure npm:

In your terminal, execute the following commands:

```bash
npm login --auth-type=legacy --registry=https://npm.pkg.github.com
USERNAME: <their GitHub username>
PASSWORD: <personal access token issued at Step 1>
echo "@ntohq:registry=https://npm.pkg.github.com" > .npmrc
```

3. Select a Developer Release:

Visit the Buefy-next package registry: https://github.com/ntohq/buefy-next/pkgs/npm/buefy-next on GitHub.

Choose any developer release that suits your needs.
- Consider the features and bug fixes introduced in each release.
- Choose a more recent release if you need the latest features, but be aware of potential instabilities.
- Opt for a slightly older release if stability is a higher priority.

**Package Naming Conventions:**

Buefy-next developer releases follow a specific naming format:

```
@ntohq/buefy-next@<package version>-<dev commit hash>
```

`<package version>`: This represents the intended stable release version that the developer release will eventually be included in.

`<dev commit hash>`: This part indicates that it's a developer release and includes a unique commit hash that identifies the specific code changes in that release.


4. Install the Package:

Copy the provided command from GitHub, which will resemble this:

```bash
npm install @ntohq/buefy-next@<package version>-<dev commit hash>
```

Alternatively, to fetch the latest release from the developer snapshot registry, run:

```bash
npm install @ntohq/buefy-next@latest
```

**However, note it is not recommended to use the latest version of our developer snapshot, as its stability fluctuates.**

Congratulations! You've successfully installed a Buefy-next developer package.

For further details on the GitHub npm registry refer to the [official GitHub documentation](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#installing-a-package)

## Start On Cloud IDE

[https://github.com/buefy/buefy](https://github.com/buefy/buefy)
Expand Down