Skip to content

Commit 236db4a

Browse files
authored
Switch to github flow (#117)
1 parent 731f9eb commit 236db4a

File tree

7 files changed

+42
-114
lines changed

7 files changed

+42
-114
lines changed

.github/workflows/ci.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
name: CI
22

33
on:
4-
push:
5-
branches: [ dev ]
4+
workflow_dispatch:
65
pull_request:
7-
branches: [ dev ]
6+
branches: [ master ]
7+
push:
8+
branches: [ master ]
89

910
# Cancel any in-flight jobs for the same PR/branch so there's only one active
1011
# at a time

.github/workflows/release.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Deploy Releases
2+
3+
on:
4+
push:
5+
tags:
6+
- '[0-9]+.[0-9]+.[0-9]+'
7+
8+
jobs:
9+
create-crates-io-release:
10+
name: Deploy to crates.io
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- uses: dtolnay/rust-toolchain@stable
15+
- run: cargo login ${{ env.CRATES_IO_TOKEN }}
16+
env:
17+
CRATES_IO_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
18+
- run: cargo publish --allow-dirty -p plotly_derive
19+
- run: sleep 10
20+
- run: cargo publish --allow-dirty -p plotly_kaleido
21+
- run: sleep 10
22+
- run: cargo publish --allow-dirty -p plotly
23+
24+
create-gh-release:
25+
name: Deploy to GH Releases
26+
runs-on: ubuntu-latest
27+
steps:
28+
- uses: softprops/action-gh-release@v1

.github/workflows/release_ci.yml

Lines changed: 0 additions & 76 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Changelog
22
All notable changes to this project will be documented in this file.
33

4-
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
5-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
4+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
65

76
## [0.8.2] - 2022-11-03
87
### Added

CONTRIBUTING.md

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,22 @@
11
# Contributing to Ploty.rs
22

3-
Contribution in the form of suggestions, bug reports, pull requests and feedback is welcome from everyone. In this document
4-
you'll find guidance if you are considering to offer your help to this project.
3+
Contribution in the form of suggestions, bug reports, pull requests and feedback is welcome from everyone. In this document you'll find guidance if you are considering to offer your help to this project.
54

6-
## Submitting bug reports and feature requests
5+
## Submitting Bug Reports and Feature Requests
76

8-
When reporting a bug or asking for help, please include enough details so that
9-
the people helping you can reproduce the behavior you are seeing. For some tips
10-
on how to approach this, read about how to produce a [Minimal, Complete, and
11-
Verifiable example].
7+
When reporting a bug or asking for help, please include enough details so that the people helping you can reproduce the behavior you are seeing. For some tips on how to approach this, read about how to produce a [Minimal, Complete, and Verifiable example].
128

139
[Minimal, Complete, and Verifiable example]: https://stackoverflow.com/help/mcve
1410

15-
When making a feature request, please make it clear what problem you intend to
16-
solve with the feature, any ideas for how Plotly.rs could support solving that
17-
problem, any possible alternatives, and any disadvantages.
11+
When making a feature request, please make it clear what problem you intend to solve with the feature, any ideas for how Plotly.rs could support solving that problem, any possible alternatives, and any disadvantages.
1812

19-
## Process
13+
## Pull Requests
2014

21-
Before spending time and effort in making changes to the library, please open an issue first explaining the proposed change
22-
and indicate that you would be happy to implement/fix the issue. Once the utility of the addition is discussed and verified,
23-
you're welcome to proceed.
15+
Before spending time and effort in making changes to the library, it's a good idea to discuss it first on the issue tracker to see whether your change is likely to be accepted.
2416

25-
Fork [plotly](https://igiagkiozis.github.io/plotly/) to your own account and checkout the `dev` branch. Once the bug/feature is complete, make sure you update
26-
appropriately the [change log](CHANGELOG.md).
17+
Fork [plotly](https://igiagkiozis.github.io/plotly/) to your own account and create a new branch for your feature. Remember to update the [changelog](CHANGELOG.md) - use previous entries as a template.
2718

28-
For change-log updates please use previous entries as reference, namely classify
29-
the nature of the change, e.g. fixed, changed, added etc., and a brief description. The entry in the change-log that should be
30-
used for the update will always be marked with YEAR-XX-XX, e.g. 2022-XX-XX.
31-
32-
Check that the test suite passes locally and that all examples still execute and produce the expected results before submitting a pull request.
33-
34-
Make a pull request with your changes directly to the `dev` branch. Please note, pull requests to the `master` branch will not
35-
be considered. The `master` branch is reserved for release.
36-
37-
38-
Also, include a description of our changes as documented in the
39-
[change-log](CHANGELOG.md); just copy paste these additions in the pull request description. Wait for one of the reviewers
40-
to look at your code and either merge it or give feedback which you should adapt to.
19+
When your contribution is ready for review, make a pull request with your changes directly to the `master` branch. One of the maintainers will have a look at what you've done, suggest any necessary changes and, when everyone is happy, merge the pull request.
4120

4221
## Code of Conduct
4322

plotly/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ version = "0.8.2"
44
description = "A plotting library powered by Plotly.js"
55
authors = ["Ioannis Giagkiozis <[email protected]>"]
66
license = "MIT"
7-
readme = "README.md"
7+
readme = "../README.md"
88
homepage = "https://github.com/igiagkiozis/plotly"
99
documentation = "https://docs.rs/plotly"
1010
repository = "https://github.com/igiagkiozis/plotly"

plotly/README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)