Skip to content

Commit dbfe668

Browse files
authored
Merge pull request #454 from highcharts/docs/update-release-shields
docs/update-release-shields
2 parents e7bc429 + 3f38411 commit dbfe668

3 files changed

Lines changed: 54 additions & 47 deletions

File tree

‎.github/workflows/main.yml‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
name: main
2-
on: [push, pull_request]
2+
on:
3+
push:
4+
branches: [master]
5+
pull_request:
6+
7+
concurrency:
8+
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
9+
cancel-in-progress: true
310

411
jobs:
512
build:

‎CONTRIBUTING.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Release
2+
3+
Using Angular CLI v19, the library must be manually rebuilt on each change in
4+
order to reflect in the demo app.
5+
6+
Run the following command on each change to the `highcharts-chart.directive.ts`
7+
file:
8+
9+
```cli
10+
npm run build
11+
```
12+
13+
If you are running the demo app in another terminal window when you rebuild the
14+
library, the changes should be reflected in your browser (note: you may need to
15+
refresh the browser a second time after the live reload in order to see the
16+
change).
17+
18+
For CHANGELOG.md update use :
19+
20+
```cli
21+
npm run release
22+
```
23+
24+
Verify CHANGELOG.md in the main folder and in the `highcharts-angular` folder.
25+
If changes are needed, added them via `git add *` & `git commit --amend`.
26+
27+
Next, run `git push --follow-tags origin master` and `npm publish` in the
28+
`highcharts-angular` folder - you'll need to be logged into npm with an account
29+
that has write access for publish.
30+
31+
Finally, use `git push --tags` and mark a new release on GitHub - the same as
32+
older tags are done there.

‎README.md‎

Lines changed: 14 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,27 @@
1+
<div align='center'>
2+
13
# Highcharts Angular
24

3-
Official minimal Highcharts integration for Angular.
5+
<i>Official Highcharts integration for Angular</i>
6+
7+
<img src="https://assets.highcharts.com/images/highcharts-logo.svg" />
8+
9+
<p>Incorporate Highcharts data visualizations in your Angular projects with Highcharts Angular.</p>
10+
11+
<img src="https://img.shields.io/npm/v/highcharts-angular?style=flat&logoColor=white&label=npm&labelColor=2a2a2a&color=e53e3e" alt="NPM Version" />
12+
<img src="https://img.shields.io/npm/dm/highcharts-angular?style=flat&logoColor=white&label=downloads&labelColor=2a2a2a&color=10b981" alt="NPM Downloads" />
13+
<img src="https://img.shields.io/discord/1318933807059042305?style=flat&logoColor=white&label=discord&labelColor=2a2a2a&color=5865F2" alt="Discord" />
14+
15+
</div>
416

517
## Links
618

719
- Official website: [www.highcharts.com](https://www.highcharts.com)
20+
- Changelog: [./CHANGELOG.md](./CHANGELOG.md)
821
- Product page: [www.highcharts.com/integrations/angular](https://www.highcharts.com/integrations/angular)
922
- Download: [www.highcharts.com/download](https://www.highcharts.com/download)
1023
- License: [www.highcharts.com/license](https://www.highcharts.com/license)
1124
- Support: [www.highcharts.com/support](https://www.highcharts.com/support)
12-
- Issues: [Working repo](https://github.com/highcharts/highcharts/issues)
13-
14-
## Table of Contents
15-
16-
1. [Getting Started](#getting-started)
17-
1. [General Prerequisites](#general-prerequisites)
18-
2. [Installing](#installing)
19-
3. [Usage](#usage)
20-
4. [SSR Support](#ssr-support)
21-
5. [Angular Elements and `useHTML`](#angular-elements-and-usehtml)
22-
6. [Upgrade to v5](#upgrade-to-v5)
23-
2. [Options Details](#options-details)
24-
3. [Chart Instance](#chart-instance)
25-
4. [Highcharts Partial Loading on the Component Level](#highcharts-partial-loading-on-the-component-level)
26-
1. [Loading a Module](#to-load-a-module)
27-
2. [Loading a Map for Highcharts Maps](#to-load-a-map-for-highcharts-maps)
28-
3. [Loading a Map for Highcharts Stock](#to-load-a-stock-for-highcharts)
29-
4. [Loading a Wrapper](#to-load-a-wrapper)
30-
5. [Demo App](#demo-app)
31-
1. [Play with the App](#play-with-the-app)
32-
2. [Files to Modify](#files-to-play-with)
33-
6. [Release](#release)
34-
7. [Help and FAQ](#help-and-faq)
35-
36-
---
3725

3826
## Getting Started
3927

@@ -554,26 +542,6 @@ Keep the console running, and modify files — after saving, the app will automa
554542

555543
This file contains the main Angular component, which utilizes different components like _line-chart_, _gantt-chart_, _map-chart_, and _stock-chart_.
556544

557-
## Release
558-
559-
Using Angular CLI v19, the library must be manually rebuilt on each change in order to reflect in the demo app.
560-
561-
Run the following command on each change to the `highcharts-chart.directive.ts` file:
562-
563-
```cli
564-
npm run build
565-
```
566-
567-
If you are running the demo app in another terminal window when you rebuild the
568-
library, the changes should be reflected in your browser (note: you may need to
569-
refresh the browser a second time after the live reload in order to see the change).
570-
571-
For CHANGELOG.md update use :
572-
573-
```cli
574-
npm run release
575-
```
576-
577545
## Help and FAQ
578546

579547
For technical support please contact [Highcharts technical support](https://www.highcharts.com/support).

0 commit comments

Comments
 (0)