Skip to content

Commit

Permalink
Merge pull request #45 from Reloadly/release/1.0.0
Browse files Browse the repository at this point in the history
Release/1.0.0
  • Loading branch information
iSeremet-Reloadly authored Dec 11, 2023
2 parents eb7cdad + f21d277 commit b4b4894
Show file tree
Hide file tree
Showing 93 changed files with 2,875 additions and 2,247 deletions.
55 changes: 55 additions & 0 deletions .github/workflows/npm-publish-beta.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Build and Publish NPM Package

on:
push:
branches:
- develop
- main

jobs:
deploy-beta:
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/develop'
steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 16
registry-url: https://registry.npmjs.org/

- name: Install dependencies
run: npm install

- name: Build
run: npm ci && npm run build:prod

- name: Publish to npm (beta version)
run: npm run npm:publish:beta
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}
deploy-release:
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 16
registry-url: https://registry.npmjs.org/

- name: Install dependencies
run: npm install

- name: Build
run: npm ci && npm run build:prod

- name: Publish to npm (release version)
run: npm run npm:publish:latest
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}
21 changes: 16 additions & 5 deletions CHANGELOG.MD
Original file line number Diff line number Diff line change
@@ -1,20 +1,31 @@
<a name="1.0.0-alpha.0"></a>
# [1.0.0-alpha.0](https://github.com/ng-bootstrap/ng-bootstrap/compare/9f8f37b...1.0.0-alpha.0) (2023-06-10)
<a name="1.0.0"></a>
# [1.0.0](https://github.com/reloadly-ui/reloadly-ui/compare/9f8f37b...1.0.0-alpha.0) (2023-09-26)

### Features

Initial release with the following directives:

* accordion
* badge
* breadcrumbs
* buttons
* button
* checkbox
* dropdown-select
* range-slider
* search-bar
* dropdown
* form-group
* input-group
* menu
* modal
* pagination
* preloader
* quick-action
* select
* sidebar
* svg
* icons
* switch
* stepper
* selection-grid
* table
* tag
* tooltip
7 changes: 3 additions & 4 deletions CONTRIBUTING.MD
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@
We are always looking for quality contributions and will be happy to accept your Pull Requests as long as they adhere to some basic rules:

- Please make sure that your contribution fits well in the project's context:
- we are aiming at rebuilding bootstrap components in pure Angular, without any dependencies on any external JavaScript library;
- the only dependency should be bootstrap CSS and its markup structure
- we are aiming at building UI components in pure Angular, without any dependencies on any external JavaScript library;
- the only dependency should be angular
- Please assure that you are submitting quality code, specifically make sure that:
- your component has accompanying tests and all the tests are passing
- your PR doesn't break the build; check the GitHub-CI build status after opening a PR and push corrective commits if anything goes wrong
- your commits conform to the conventions established [here](DEVELOPER.md#commit-messages)
- your component follows all the conventions stated [here](https://github.com/reloadly/reloadly-ui/wiki/Contributions%3A-Code-conventions)
- your code formatting style should match the existing formatting standards.
22 changes: 4 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,7 @@

Angular UI library for building rich UI experiences

[![npm version](https://badge.fury.io/js/%40ng-bootstrap%2Fng-bootstrap.svg)](https://badge.fury.io/js/%40ng-bootstrap%2Fng-bootstrap)
[![Build Status](https://github.com/ng-bootstrap/ng-bootstrap/workflows/ci/badge.svg?branch=master)](https://github.com/ng-bootstrap/ng-bootstrap/actions)
[![codecov](https://codecov.io/gh/ng-bootstrap/ng-bootstrap/branch/master/graph/badge.svg)](https://codecov.io/gh/ng-bootstrap/ng-bootstrap)
[![devDependency Status](https://david-dm.org/ng-bootstrap/ng-bootstrap/dev-status.svg?branch=master)](https://david-dm.org/ng-bootstrap/ng-bootstrap#info=devDependencies)
[![Sauce Test Status](https://saucelabs.com/browser-matrix/pkozlowski.svg)](https://saucelabs.com/u/pkozlowski)
[![npm version](https://badge.fury.io/js/reloadly-ui.svg)](https://badge.fury.io/js/reloadly-ui)

Please check our [demo site](https://ui.reloadly.com) and the list of
[issues](https://github.com/reloadly/reloadly-ui/issues) to see all the things we are working on. Feel free to make comments there.
Expand Down Expand Up @@ -58,29 +54,19 @@ Our code is automatically tested on all supported browsers.

## Getting help

Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [StackOverflow](http://stackoverflow.com/questions/tagged/reloadly-ui) where maintainers are looking at questions tagged with `ng-bootstrap`.

StackOverflow is a much better place to ask questions since:

- there are hundreds of people willing to help on StackOverflow
- questions and answers stay available for public viewing so your question/answer might help someone else
- Stack Overflow's voting system assures that the best answers are prominently visible.

To save your and our time we will be systematically closing all the issues that are requests for general support and redirecting people to StackOverflow.
Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. For general support questions you can try StackOverflow and tag the question with the `reloadly-ui` tag.

## Do you think you've found a bug?

We want to fix it ASAP! But before fixing a bug we need to reproduce and confirm it.

We ask you to respect two things:

- fill the GitHub issue template by providing the bug description and appropriate versions of Angular, ng-bootstrap and TypeScript
- provide a use-case that fails with a **minimal reproduction scenario** using [StackBlitz](https://stackblitz.com) (you can start by forking one from our [demo page](https://ui.reloadly.com/#/components))
- fill the GitHub issue template by providing the bug description and appropriate versions of Angular, reloadly-ui and TypeScript
- provide a use-case that fails with a **minimal reproduction scenario** using [StackBlitz](https://stackblitz.com)

A minimal reproduction scenario allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.

Please note that **we will be insisting on a minimal reproduction scenario** in order to save maintainers time and ultimately be able to fix more bugs. We'll mark the issue as non-actionable without it and close if not heard from the reporter.

Interestingly, from our experience users often find coding problems themselves while preparing a minimal StackBlitz. We understand that sometimes it might be hard to extract essential bits of code from a larger code-base but we really need to isolate the problem before we can fix it.

## Contributing to the project
Expand Down
Loading

0 comments on commit b4b4894

Please sign in to comment.