Skip to content

Commit 5c5b974

Browse files
authored
Remove change logs and link to releases page instead (#192)
1 parent 8b1d66c commit 5c5b974

File tree

2 files changed

+5
-151
lines changed

2 files changed

+5
-151
lines changed

CHANGES.md

Lines changed: 1 addition & 145 deletions
Original file line numberDiff line numberDiff line change
@@ -1,145 +1 @@
1-
## 0.6.0
2-
3-
* Add instructions to fix header issues in markdown comment.
4-
* Add Eclipse Foundation specific Apache 2.0 license header.
5-
* Add support for OPA policy files, protobuf.
6-
* Add weak-compatible check to dependency check.
7-
8-
## 0.5.0
9-
10-
* feat(header templates): add support for AGPL-3.0 by @elijaholmos in https://github.com/apache/skywalking-eyes/pull/125
11-
* Upgrade go version to 1.18 by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/126
12-
* Add MulanPSL-2.0 support. by @jmjoy in https://github.com/apache/skywalking-eyes/pull/127
13-
* New Header Template: GPL-3.0-or-later by @ddlees in https://github.com/apache/skywalking-eyes/pull/128
14-
* Update README.md by @rovast in https://github.com/apache/skywalking-eyes/pull/129
15-
* Add more `.env.[mode]` support for VueJS project by @rovast in https://github.com/apache/skywalking-eyes/pull/130
16-
* Docker Multiple Architecture Support :fixes#9089 by @mohammedtabish0 in https://github.com/apache/skywalking-eyes/pull/132
17-
* Polish maven test for convenient debug by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/134
18-
* feat: list files by git when possible by @tisonkun in https://github.com/apache/skywalking-eyes/pull/133
19-
* Switch to npm ci for reliable builds by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/135
20-
* Fix optional dependencies are not excluded by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/136
21-
* Fix exclude not work for transitive dependencies and add recursive config by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/137
22-
* Add some tests for maven resovler by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/138
23-
* feat(header-fix): add Svelte support by @elijaholmos in https://github.com/apache/skywalking-eyes/pull/139
24-
* dep: do not write license files if they already exist by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/140
25-
* fix: not ignore *.txt to make sure files like CMakeLists.txt can be checked by @acelyc111 in https://github.com/apache/skywalking-eyes/pull/141
26-
* fix license header normalizer by @xiaoyawei in https://github.com/apache/skywalking-eyes/pull/142
27-
* Substitute variables in license content for header command by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/143
28-
* Correct indent in Apache-2.0 template by @tisonkun in https://github.com/apache/skywalking-eyes/pull/144
29-
* Add copyright-year configuration by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/145
30-
* dep/maven: use output file to store the dep tree for cleaner result by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/146
31-
* dep/maven: resolve dependencies before analysis by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/147
32-
* gha: switch to composite running mode and set up cache by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/149
33-
* Fix GitHub Actions wrong path by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/151
34-
* Normalize license for cargo. by @jmjoy in https://github.com/apache/skywalking-eyes/pull/153
35-
* Remove space characters in license for cargo. by @jmjoy in https://github.com/apache/skywalking-eyes/pull/154
36-
* Bump up dependencies to fix CVE by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/155
37-
* Bump up GHA to depress warnings by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/156
38-
* Leverage the built-in cache in setup-go@v4 by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/157
39-
* Dependencies check should report unknown licneses by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/158
40-
* Fix wrong indentation in doc by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/159
41-
* Add EPL-2.0 header template by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/160
42-
* Dependency resolve with default template and specified output of license by @crholm in https://github.com/apache/skywalking-eyes/pull/163
43-
* Bump up go git to support .gitconfig user path by @kezhenxu94 in https://github.com/apache/skywalking-eyes/pull/164
44-
45-
## 0.4.0
46-
- Reorganize GHA by header and dependency. (#123)
47-
- Add rust cargo support for dep command. (#121)
48-
- Support license expression in dep check. (#120)
49-
- Prune npm packages before listing all dependencies (#119)
50-
- Add support for multiple licenses in the header config section (#118)
51-
- Add `excludes` to `license resolve` config (#117)
52-
- maven: set `group:artifact` as dependency name and extend functions in summary template (#116)
53-
- Stablize summary context to perform consistant output (#115)
54-
- Add custom license urls for identification (#114)
55-
- Lazy initialize GitHub client for comment (#111)
56-
- Make license identifying threshold configurable (#110)
57-
- Use Google's licensecheck to identify licenses (#107)
58-
- dep: short circuit if user declare dep license (#108)
59-
60-
## 0.3.0
61-
62-
- Dependency License
63-
- Fix license check in go library testify (#93)
64-
65-
- License Header
66-
- `fix` command supports more languages:
67-
- Add comment style for cmake language (#86)
68-
- Add comment style for hcl (#89)
69-
- Add mpl-2.0 header template (#87)
70-
- Support fix license header for tcl files (#102)
71-
- Add python docstring comment style (#100)
72-
- Add comment style for makefile & editorconfig (#90)
73-
- Support config license header comment style (#97)
74-
- Trim leading and trailing newlines before rewrite license header cotent (#94)
75-
- Replace already existing license header based on pattern (#98)
76-
- [docs] add the usage for config the license header comment style (#99)
77-
78-
- Project
79-
- Obtain default github token in github actions (#82)
80-
- Add tests for bare spdx license header content (#92)
81-
- Add github action step summary for better experience (#104)
82-
- Adds an option to the action to run in `fix` mode (#84)
83-
- Provide `--summary` flag to generate the license summary file (#103)
84-
- Add .exe suffix to windows binary (#101)
85-
- Fix wrong file path and exclude binary files in src release (#81)
86-
- Use t.tempdir to create temporary test directory (#95)
87-
- Config: fix incorrect log message (#91)
88-
- [docs] correct spelling mistakes (#96)
89-
90-
## 0.2.0
91-
92-
- Dependency License
93-
- Support resolving go.mod for Go
94-
- Support resolving pom.xml for maven (#50)
95-
- Support resolving jars' licenses (#53)
96-
- Support resolving npm dependencies' licenses (#48)
97-
- Support saving dependencies' licenses (#69)
98-
- Add `dependency check` to check dependencies license compatibilities (#58)
99-
100-
- License Header
101-
- `fix` command supports more languages:
102-
- Add support for plantuml (#42)
103-
- Add support for PHP (#40)
104-
- Add support for Twig template language (#39)
105-
- Add support for Smarty template language (#38)
106-
- Add support for MatLab files (#37)
107-
- Add support for TypeScript language files (#73)
108-
- Add support for nextflow files (#65)
109-
- Add support for perl files (#63)
110-
- Add support for ini extension (#24)
111-
- Add support for R files (#64)
112-
- Add support for .rst files and allow fixing header of a single file (#25)
113-
- Add support for Rust files (#29)
114-
- Add support for bat files (#32)
115-
- Remove .tsx from XML language extensions
116-
- Honor Python's coding directive (#68)
117-
- Fix file extension conflict between RenderScript and Rust (#66)
118-
- Add comment type to cython declaration (#62)
119-
- header fix: respect user configured license content (#60)
120-
- Expose `license-location-threshold` as config item (#34)
121-
- Fix infinite recursive calls when containing symbolic files (#33)
122-
- defect: avoid crash when no comment style is found (#23)
123-
124-
- Project
125-
- Enhance license identification (#79)
126-
- Support installing via go install (#76)
127-
- Speed up the initialization phase (#75)
128-
- Resolve absolute path in `.gitignore` to relative path (#67)
129-
- Reduce img size and add npm env (#59)
130-
- Make the config file and log level in GitHub Action configurable (#56, #57)
131-
- doc: add a PlantUML activity diagram of header fixing mechanism (#41)
132-
- Fix bug: license file is not found but reported message is nil (#49)
133-
- Add all well-known licenses and polish normalizers (#47)
134-
- Fix compatibility issues in Windows (#44)
135-
- feature: add reasonable default config to allow running in a new repo without copying config file (#28)
136-
- chore: only build linux binary when building inside docker (#26)
137-
- chore: upgrade to go 1.16 and remove `go-bindata` (#22)
138-
- Add documentation about how to use via docker image (#20)
139-
140-
## 0.1.0
141-
142-
- License Header
143-
+ Add `check` and `fix` command.
144-
+ `check` results can be reported to pull request as comments.
145-
+ `fix` suggestions can be filed on pull request as edit suggestions.
1+
Check the [release notes](https://github.com/apache/skywalking-eyes/releases) for detailed change logs.

docs/How-to-release.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ This documentation guides the release manager to release the SkyWalking Eyes in
55
## Prerequisites
66

77
1. Close (if finished, or move to next milestone otherwise) all issues in the current milestone from [skywalking-eyes](https://github.com/apache/skywalking-eyes/milestones) and [skywalking](https://github.com/apache/skywalking/milestones), create a new milestone if needed.
8-
1. Update [CHANGES.md](../CHANGES.md).
9-
108

119
## Add your GPG public key to Apache svn
1210

@@ -16,7 +14,6 @@ This documentation guides the release manager to release the SkyWalking Eyes in
1614

1715
1. Add your GPG public key into [SkyWalking GPG KEYS](https://dist.apache.org/repos/dist/release/skywalking/KEYS) file, **you can do this only if you are a PMC member**. You can ask a PMC member for help. **DO NOT override the existed `KEYS` file content, only append your key at the end of the file.**
1816

19-
2017
## Build and sign the source code package
2118

2219
```shell
@@ -27,10 +24,11 @@ git tag -a "v$VERSION" -m "Release Apache SkyWalking-Eyes $VERSION"
2724
git push --tags
2825

2926
make clean
30-
31-
make test # this is optional, it runs sanity checks to verify the features
32-
27+
make verify # this is optional, it runs sanity checks to verify the features
3328
make release
29+
30+
# Create a draft release in GitHub, this can be optionally done in GitHub web ui.
31+
gh release create v$VERSION --generate-notes --draft skywalking-license-eye-$VERSION-*
3432
```
3533

3634
## Upload to Apache svn

0 commit comments

Comments
 (0)