From 79074370a278d00c279444e3a09e1da34e37b771 Mon Sep 17 00:00:00 2001 From: Kiko Beats Date: Mon, 25 May 2015 23:52:56 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0056ee0..317e1c9 100755 --- a/README.md +++ b/README.md @@ -115,7 +115,7 @@ For example, I want to add a new file called `component.json` that have the vers ```json { -"version": "2.0.0" + "version": "2.0.0" } ``` @@ -133,6 +133,7 @@ If you check now the `.bumpedrc` file the list of configuration files as been up ```cson files: [ "package.json" + "component.json" ] ``` From 7dd952afc97cb356d2e36d848766c7c1da91d527 Mon Sep 17 00:00:00 2001 From: Elena Torro Date: Fri, 29 May 2015 21:27:48 +0200 Subject: [PATCH 2/3] README revised --- README.md | 62 ++++++++++++++++++++++++++----------------------------- 1 file changed, 29 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 317e1c9..bf250b0 100755 --- a/README.md +++ b/README.md @@ -18,12 +18,12 @@ ## Why? -- Separates the process of create software to publish software. -- Synchronizes, unifies and publishes your software version in the different packages managers. -- Easy to integrate with current or new projects. -- Associates actions before or after publish your software *(not yet, but soon!)*. +- Bumped separates the processes of creating and publishing software. +- It syncronizes, unifies and publishes different software versions into the different package managers. +- It is easy to integrate it with both with your current and new projects. +- It will associate actions before or after publishing your software *(not yet, but soon!)*. -**Bumped** synchronizes the version of your software across different package managers configuration files (npm, bower,...) and controls, edits and releases the version for be sure that is the same in all the files. +**Bumped** synchronizes your software version across different package manager configuration files (npm, bower,...) and controls, edits and releases each of its versions to ensure all the files have the same version. Because writing software is hard enough, we must make the publishing process of software simple and effective. @@ -37,19 +37,18 @@ npm install bumped -g ### .init -The first command that you need to run is `bumped init`. If you run it in a totally blank project, you -see something like: +The first command that you need to run is `bumped init`. If you run it in a totally blank project, you'll see something like this: ```bash $ bumped init warn : It has been impossible to detect files automatically. -warn : Try to add manually with 'add' command. -warn : There aren't a version declared. +warn : It tries to add manually with 'add' command. +warn : There is no version declared. success : Config file created!. ``` -But running it in a project with common package managers configuration files `package.json` or `bower.json` the magic begins to appear: +The magic appears when running it in a project with common package manager configuration files, for instance, both `package.json` and `bower.json`: ```bash $ bumped init @@ -59,7 +58,7 @@ info : Current version is '1.0.1'. success : Config file created!. ``` -At this moment, **Bumped** will create a configuration file `.bumpedrc` that is associate with the folder of the project. If you open the files this content a list of files to syncrhonizes: +At this moment, **Bumped** creates a configuration file `.bumpedrc`, which is associated with the project folder. If you open this file, its content is a list made up of all the synchronized files: ```cson files: [ @@ -67,11 +66,11 @@ files: [ ] ``` -The format of the file is [CSON](https://github.com/bevry/cson), However you can use JSON, but this file is auto-generate for **Bumped**. +The file format is [CSON](https://github.com/bevry/cson). You can also use JSON format, hover, this file is auto-generated by **Bumped**. ### .version -When you are not sure what is the current version synchronized across your configuration files just run `bumped version`: +If you're not sure what the current synchronized version across your configuration files is, then run `bumped version`: ```bash $ bumped version @@ -79,19 +78,19 @@ $ bumped version info : Current version is '1.0.0'. ``` -The shared version of the files is the major version detected between them. However, will not be syncrhonized until the next releases. +The shared version is the major version detected in them. On the other hand, it will not be syncrhonized until the next release. ### .release -It's moment to release a new version of your sofware. You can do this in two different ways. +It's moment to release a new version of your sofware. You can do this in two different ways: -- Providing the exact version that you want to release +- Providing the exact version that you want to release. - Providing the semantic semver version to release (using the keywords `major`, `minor`, `patch`,... -In both cases the unique requisite is that the version to be releases want to be major that the current version. +In both cases, the only requisite is that the version to be released has to be major than the current version. -For example, if your current version is `1.0.0` and you want to release the version `1.1.0` you can do: +For example, if your current version is `1.0.0` and you want to release to the version `1.1.0`, you can do: ```bash $ bumped release 1.1.0 @@ -99,7 +98,7 @@ $ bumped release 1.1.0 success : Releases version '1.1.0'. ``` -or, if you prefer a more semantic semver way to do the same you can do: +Or, if you prefer a more semantic semver way to do the same, you simply can do: ```bash $ bumped release minor @@ -109,9 +108,9 @@ success : Releases version '1.1.0'. ### .add -In the beginning **Bumped** automatically detect common configuration files of the most popular packages managers, but maybe you need to add one manually. +In the beginning, **Bumped** automatically detects common configuration files from the most popular packages managers, but you may need to add one manually. -For example, I want to add a new file called `component.json` that have the version setted to `2.0.0`: +For example, I want to add a new file called `component.json` that which version setted to `2.0.0`: ```json { @@ -119,7 +118,7 @@ For example, I want to add a new file called `component.json` that have the vers } ``` -For do it, use `bumped add` command: +I can be done typing `bumped add`: ```bash $ bumped add component.json @@ -128,7 +127,7 @@ info : Detected 'component.json' in the directory. success : 'component.json' has been added. ``` -If you check now the `.bumpedrc` file the list of configuration files as been updated: +If you check now the `.bumpedrc` file, the list of configuration files has been updated: ```cson files: [ @@ -137,7 +136,7 @@ files: [ ] ``` -If you type now `bumped version` you can check that the share version has changed: +If you type now `bumped version`, you can check that the shared version has changed: ```bash $ bumped version @@ -145,11 +144,11 @@ $ bumped version info : Current version is '2.0.0'. ``` -Because is the most major version shared between the configuration files. +The version is setted to 2.0.0 because it's the major version between all the configuration files. ### .remove -If you decide to remove a file, just use `remove` command: +If you decide to remove a file, just use the `remove` command: ``` bumped remove component.json @@ -159,16 +158,13 @@ info : 'component.json' has been removed. ## What's next? -The really interesting in **Bumped** is the posibility to associate *hooks* before or after a release action. For example, imagine that, when you going to release a new version of your software: - -- Run a grunt/gulp task for generate a build. +The most interesting aspect in **Bumped** is the posibility to associate *hooks* before or after a release action. Usually, every time you releases a new version of your software, you always have to accomplish several tasks: +- Run a grunt/gulp task to generate a build. - Create a tagged version using `git`. -- Pushing the code in a `git` repository. +- Push the code to a `git` repository. - Check if you are using dependencies with vulnerabilities using [NSP](https://nodesecurity.io). -And, basically, whatever that you want. - -Because the core is stable and usable, I decided release early without this feature, but only need a little of time! +Due to the core is stable and usable, I decided to release early without this new feature. I just need a little bit of time! ## License From a7578bec3173d3d12d9fbe953445ed866a86639a Mon Sep 17 00:00:00 2001 From: Kiko Beats Date: Fri, 29 May 2015 22:47:31 +0200 Subject: [PATCH 3/3] some fixes --- README.md | 21 ++++++++++++--------- lib/Bumped.messages.coffee | 2 +- 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index bf250b0..77d711e 100755 --- a/README.md +++ b/README.md @@ -18,10 +18,10 @@ ## Why? -- Bumped separates the processes of creating and publishing software. -- It syncronizes, unifies and publishes different software versions into the different package managers. -- It is easy to integrate it with both with your current and new projects. -- It will associate actions before or after publishing your software *(not yet, but soon!)*. +- Separates the processes of creating and publishing software. +- Syncronizes, unifies and publishes different software versions into the different package managers. +- Easy to integrate it with both with your current and new projects. +- Associated actions before or after publishing your software *(not yet, but soon!)*. **Bumped** synchronizes your software version across different package manager configuration files (npm, bower,...) and controls, edits and releases each of its versions to ensure all the files have the same version. @@ -43,12 +43,12 @@ The first command that you need to run is `bumped init`. If you run it in a tota $ bumped init warn : It has been impossible to detect files automatically. -warn : It tries to add manually with 'add' command. -warn : There is no version declared. +warn : Try to add manually with 'add' command. +warn : There isn't version declared. success : Config file created!. ``` -The magic appears when running it in a project with common package manager configuration files, for instance, both `package.json` and `bower.json`: +The magic appears when running it in a project with common package manager configuration files, for instance, like `package.json` or `bower.json`: ```bash $ bumped init @@ -66,11 +66,11 @@ files: [ ] ``` -The file format is [CSON](https://github.com/bevry/cson). You can also use JSON format, hover, this file is auto-generated by **Bumped**. +The file format is [CSON](https://github.com/bevry/cson). You can also use JSON format, however, this file is auto-generated by **Bumped**. ### .version -If you're not sure what the current synchronized version across your configuration files is, then run `bumped version`: +If you're not sure what the current synchronized version across your configuration files, then run `bumped version`: ```bash $ bumped version @@ -160,10 +160,13 @@ info : 'component.json' has been removed. The most interesting aspect in **Bumped** is the posibility to associate *hooks* before or after a release action. Usually, every time you releases a new version of your software, you always have to accomplish several tasks: - Run a grunt/gulp task to generate a build. +- Lint the code. - Create a tagged version using `git`. - Push the code to a `git` repository. - Check if you are using dependencies with vulnerabilities using [NSP](https://nodesecurity.io). +And, basically, whatever that you need. + Due to the core is stable and usable, I decided to release early without this new feature. I just need a little bit of time! ## License diff --git a/lib/Bumped.messages.coffee b/lib/Bumped.messages.coffee index 38657de..d7c9a6f 100644 --- a/lib/Bumped.messages.coffee +++ b/lib/Bumped.messages.coffee @@ -16,6 +16,6 @@ module.exports = NOT_DETECTED_FILE : (file) -> "'#{file}' hasn\'t been detected in the directory." NOT_VALID_VERSION : (version) -> "version '#{version}' provided to release is not valid." NOT_GREATER_VERSION : (last, old) -> "version '#{last}' is not greater that the current '#{old}' version." - NOT_CURRENT_VERSION : -> 'There aren\'t a version declared.' + NOT_CURRENT_VERSION : -> 'There isn\'t version declared.' NOT_AUTODETECTED : -> "It has been impossible to detect files automatically." NOT_AUTODETECTED_2 : -> "Try to add manually with 'add' command."