safedb 0.02.0003 → 0.02.0004

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/CONTRIBUTING.md +68 -0
  3. data/lib/version.rb +1 -1
  4. metadata +3 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e936ff4d6ea7c3fed40d1e71ff330129cd761738ebd4d8ea560ebc6a11df8593
4
- data.tar.gz: b827be41fe4b91bf1acdfef67293f735c1ceafbf2e27a06292cbdbb0f590a30f
3
+ metadata.gz: 3972541abafe1067c0e1a680e293c7ea2628a05aced5163be8702bd35caa3b1e
4
+ data.tar.gz: 2c75a4f3e3054ffafa4d317a247619d44b7759669ee06305f358ff1e75035ac7
5
5
  SHA512:
6
- metadata.gz: eb2432b5ee6eb4d672abd5725d69754b2b0500ff96f061137b8e24612bac5fa1b9dac2b4c3f018416ce6a43372b4ddcd1c4a334f366620aaa02a3ad0b17234a5
7
- data.tar.gz: 747e96b2a389bfa2881cee57f203d4ce970f88090335ffd1ef046074f8419a84853fef6401a802c19cc778df7a5b388a6b97cfd3ae3fe434145f5e9955c71848
6
+ metadata.gz: d721368d19af9640f7803cfdd1c963385223c118a2b5fe1748fe7dc7ba1a8851d198d6ad987124f43e15a17d0c9690b0b863af86dc411252451df650edb6e8f9
7
+ data.tar.gz: a289b23d37c473113799f8af04ec76fa37087ac938946de4d579acfd4423f7548f4a935982fbce394809e2ff4f35b1aa3bb86bd69cfc44fcc924a25db0af8985
data/CONTRIBUTING.md ADDED
@@ -0,0 +1,68 @@
1
+
2
+ # How to Contribute to the Safe
3
+
4
+ You can contriubute software, documentation, issues and even good ideas. Most contributions will either be integrations with other tools and technologies, or new use cases (plugins).
5
+
6
+
7
+ ## Contributing Software
8
+
9
+ To contribute software you'll need to setup a development environment.
10
+
11
+ ```
12
+ sudo apt-get install --assume-yes ruby-full, libicu-dev, git
13
+ sudo chown -R $USER:$USER /var/lib/gems
14
+ sudo chown -R $USER:$USER /usr/local/bin
15
+ gem install safedb bundler
16
+ git clone https://github.com/devops4me/safedb.net.git mirror.safedb.ro
17
+ cd mirror.safedb
18
+ rake install
19
+ ```
20
+
21
+ You change the software as you see fit and **send a pull request** when you are ready.
22
+
23
+
24
+ ## Releasing Software
25
+
26
+ Those with priveleges to release to safedb.net will have a private key to push (or pull) in git repository changes.
27
+
28
+ To release the software to the rubygems.org platform, commonly via a **continuous integration pipeline** based on Jenkins 2.0, one needs
29
+
30
+ - **either** the email address / password combination
31
+ - **or** a credentials file containing a hex API key
32
+
33
+ Release actors are also responsible for bumping the gem version via semantic versioning principles.
34
+
35
+ ### git push to github.com/devops4me/safedb.net
36
+
37
+ Write out the SSH config and private key files.
38
+
39
+ ```
40
+ safe login safe.ecosystem
41
+ safe open <<chapter>> <<verse>>
42
+ cd ~/.ssh
43
+ safe eject github.ssh.config
44
+ safe eject safedb.code.private.key
45
+ chmod 600 safedb.code.private.key
46
+ cd <<repositories-folder>>
47
+ ssh -i ~/.ssh/safedb.code.private.key.pem -vT git@safedb.code
48
+ git clone git@safedb.code:devops4me/safedb.net.git mirror.safedb.code
49
+ ```
50
+
51
+ If a config file already exists then safe will back it up with a timestamp prefix before clobbering the file. Now bump up the major, minor or patch versions, then commit.
52
+
53
+
54
+ ### rake release RubyGems.org
55
+
56
+ Use **`gem push`** at the repository root to create a **rubygems API key** and slurp it up from the **`~/.gem/credentials`** with **`safe file rubygems.org.credentials ~/.gem/credentials`**
57
+
58
+ Now when releasing we eject the file back into **`~/.gem/credentials`**, secure it and then push up the latest gem changes.
59
+
60
+ ```
61
+ cd ~/.gem
62
+ safe eject rubygems.org.credentials
63
+ chmod 0600 credentials
64
+ cd <<gem-repository-directory>>
65
+ git push -u origin master
66
+ rake install
67
+ rake release
68
+ ```
data/lib/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module SafeDb
2
- VERSION = "0.02.0003"
2
+ VERSION = "0.02.0004"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: safedb
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.02.0003
4
+ version: 0.02.0004
5
5
  platform: ruby
6
6
  authors:
7
7
  - Apollo Akora
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-02-17 00:00:00.000000000 Z
11
+ date: 2019-02-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: inifile
@@ -79,6 +79,7 @@ extra_rdoc_files: []
79
79
  files:
80
80
  - ".gitignore"
81
81
  - ".yardopts"
82
+ - CONTRIBUTING.md
82
83
  - Gemfile
83
84
  - LICENSE
84
85
  - README.md