Update docs and bump to 0.1.0 (#6)

apache · Jan 16, 2025 · a3fc0c7 · a3fc0c7
1 parent da84efe
commit a3fc0c7
Show file tree

Hide file tree

Showing 7 changed files with 133 additions and 15 deletions.
diff --git a/.gitignore b/.gitignore
@@ -77,4 +77,5 @@ build-iPhoneSimulator/
 Gemfile.lock
 gemfiles/*.lock
 .DS_Store!
-spec/workspace
+spec/workspace
+*.tgz*
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,51 @@
+# Contributing to Apache SkyWalking Ruby
+
+Firstly, thanks for your interest in contributing! We hope that this will be a pleasant experience for you,
+so that you will return to continue contributing.
+
+## Code of Conduct
+
+The project and everyone participating in it is governed by the Apache software Foundation's [Code of Conduct](http://www.apache.org/foundation/policies/conduct.html).
+By participating, you are expected to adhere to this code. If you are aware of unacceptable behavior, please visit the [Reporting Guidelines page](http://www.apache.org/foundation/policies/conduct.html#reporting-guidelines)
+and follow the instructions there.
+
+## Contribute
+
+Most of the contributions that we receive are code contributions, but you can also contribute to the documentation or simply report solid bugs for us to fix.
+
+## Report a bug
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/apache/skywalking/issues).
+
+* If you're unable to find an issue addressing the problem, [open a new one](https://github.com/apache/skywalking/issues/new).
+Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not happening.
+
+## Compiling and building
+
+We recommend using a Ruby base image of at least 3.0 to build skywalking-ruby project
+
+```shell
+docker run -it --rm -v $(pwd)/skywalking-ruby:/workspace -w /workspace ruby:3.0 bash
+```
+
+Then run the following commands to build the project:
+
+```shell
+gem build skywalking.gemspec
+```
+
+## Add a new feature or enhance an existing one
+
+_Before making any significant changes, please [open an issue](https://github.com/apache/skywalking/issues)._
+Discussing your proposed changes ahead of time will make the contribution process smooth for everyone.
+
+Once we've discussed your changes and you've got your code ready, make sure that tests are passing and open your pull request. Your PR is most likely to be accepted if it:
+
+* Update the README.md with details of changes to the interface.
+* Includes tests for new functionality.
+* References the original issue in description, e.g. "Resolves #123", "Closes #123", or "Fixes #123", etc.
+* Has a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+## Questions about the source code
+
+* Join `#skywalking` channel at [Apache Slack](https://s.apache.org/slack-invite)
diff --git a/Makefile b/Makefile
@@ -0,0 +1,38 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+.PHONY: license
+license: license
+	docker run -it --rm -v $(shell pwd):/github/workspace ghcr.io/apache/skywalking-eyes/license-eye:20da317d1ad158e79e24355fdc28f53370e94c8a header check
+
+.PHONY: clean
+clean:
+	rm -rf skywalking-ruby*.tgz*
+	rm -rf skywalking*.gem
+
+.PHONY: release
+release: clean
+	tar -zcvf "skywalking-ruby-src-${VERSION}.tgz" \
+          --exclude .git \
+          --exclude .idea \
+          --exclude .cache \
+          --exclude .DS_Store \
+          --exclude .github \
+          --exclude .gitignore \
+          --exclude .gitmodules \
+          --exclude "skywalking-ruby-*.tgz*" *
+	gpg --batch --yes --armor --detach-sig skywalking-ruby-src-${VERSION}.tgz
+	shasum -a 512 skywalking-ruby-src-${VERSION}.tgz > skywalking-ruby-src-${VERSION}.tgz.sha512
diff --git a/README.md b/README.md
@@ -8,9 +8,12 @@ Apache SkyWalking Ruby Agent
 **SkyWalking**: an APM(application performance monitor) system, especially designed for
 microservices, cloud native and container-based (Docker, Kubernetes, Mesos) architectures.
 
-# Documentation
+## Documentation
 - [Official documentation](https://skywalking.apache.org/docs/#RubyAgent)
 
+## Contributing
+Before submitting a pull request or pushing a commit, please read our [contributing](CONTRIBUTING.md).
+
 ## Contact Us
 * Submit [an issue](https://github.com/apache/skywalking/issues/new) by using [Ruby] as title prefix.
 * Mail list: **dev@skywalking.apache.org**. Mail to `dev-subscribe@skywalking.apache.org`, follow the reply to subscribe the mail list.

diff --git a/docs/en/development-and-contribution/how-to-release.md b/docs/en/development-and-contribution/how-to-release.md
@@ -25,7 +25,7 @@ export VERSION=<the version to release>
 git clone --recurse-submodules git@github.com:apache/skywalking-ruby && cd skywalking-ruby
 git tag -a "v$VERSION" -m "Release Apache SkyWalking-Ruby $VERSION"
 git push --tags
-
+make release
 ```
 
 ## Upload to Apache svn
@@ -37,11 +37,17 @@ cp skywalking-ruby/skywalking*.tgz release/skywalking/ruby/"$VERSION"
 cp skywalking-ruby/skywalking*.tgz.asc release/skywalking/ruby/"$VERSION"
 cp skywalking-ruby/skywalking*.tgz.sha512 release/skywalking/ruby/"$VERSION"
 
-cd release/skywalking && svn add ruby/$VERSION && svn commit ruby -m "Draft Apache SkyWalking-Ruby release $VERSION"
+cd release/skywalking/ruby && svn add $VERSION && svn commit -m "Draft Apache SkyWalking-Ruby release $VERSION"
 ```
 
 ## Call for vote in dev@ mailing list
 
+First, generate a sha512sum for the source code package generated in last step:
+
+```shell
+sha512sum release/skywalking/ruby/"$VERSION"/skywalking-ruby-src-"$VERSION".tgz
+```
+
 Call for vote in `dev@skywalking.apache.org`.
 
 ```text
@@ -52,6 +58,9 @@ Content:
 Hi the SkyWalking Community:
 This is a call for vote to release Apache SkyWalking Ruby version $VERSION.
 
+We welcome any comments you may have, and will take all feedback into
+account if a quality vote is called for this build.
+
 Release notes:
 
  * https://github.com/apache/skywalking-ruby/blob/v$VERSION/CHANGELOG.md
@@ -76,17 +85,10 @@ Keys to verify the Release Candidate :
 
 Guide to build the release from source :
 
- * https://github.com/apache/skywalking-ruby/blob/master/CONTRIBUTING.md#compiling-and-building
-
-Voting will start now and will remain open for at least 72 hours, all PMC members are required to give their votes.
-
-[ ] +1 Release this package.
-[ ] +0 No opinion.
-[ ] -1 Do not release this package because....
-
-Thanks.
+ * https://github.com/apache/skywalking-ruby/blob/main/CONTRIBUTING.md#compiling-and-building
 
-[1] https://github.com/apache/skywalking-ruby/blob/master/docs/How-to-release.md#vote-check
+A vote regarding the quality of this test build will be initiated
+within the next couple of days.
 ```
 
 ## Vote Check

diff --git a/docs/en/setup/quick-start.md b/docs/en/setup/quick-start.md
@@ -19,6 +19,29 @@ gem "skywalking"
 
 Besides, you can also make installation as simple as `gem install skywalking`.
 
+## Installing from Source Code
+
+**Download the source tar from the [official website](http://skywalking.apache.org/downloads/), and run the following commands to build from source**
+
+**Make sure you have Ruby 3.0+ and the `gem` command available**
+
+~~~shell
+tar -zxf skywalking-ruby-src-<version>.tgz
+cd skywalking-ruby-src-<version>
+gem build skywalking.gemspec
+~~~
+
+If successful, the following will be displayed:
+
+```ruby
+  Successfully built RubyGem
+  Name: skywalking
+  Version: <version>
+  File: skywalking-<version>.gem
+```
+
+Then you can use `skywalking-<version>.gem` to your gemfile.
+
 ## Getting started with Rails
 
 You need to manually add `Skywalking.start` under config/initializers directory.

diff --git a/lib/skywalking/version.rb b/lib/skywalking/version.rb
@@ -14,5 +14,5 @@
 #  limitations under the License.
 
 module Skywalking
-  VERSION = "0.0.0.beta2".freeze
+  VERSION = "0.1.0".freeze
 end