forked from palantir/godel
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit ecdcfd4
Showing
544 changed files
with
109,863 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
*.iml | ||
*.ipr | ||
*.iws | ||
.idea/ | ||
/build | ||
/dist |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,201 @@ | ||
Apache License | ||
Version 2.0, January 2004 | ||
http://www.apache.org/licenses/ | ||
|
||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
||
1. Definitions. | ||
|
||
"License" shall mean the terms and conditions for use, reproduction, | ||
and distribution as defined by Sections 1 through 9 of this document. | ||
|
||
"Licensor" shall mean the copyright owner or entity authorized by | ||
the copyright owner that is granting the License. | ||
|
||
"Legal Entity" shall mean the union of the acting entity and all | ||
other entities that control, are controlled by, or are under common | ||
control with that entity. For the purposes of this definition, | ||
"control" means (i) the power, direct or indirect, to cause the | ||
direction or management of such entity, whether by contract or | ||
otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
||
"You" (or "Your") shall mean an individual or Legal Entity | ||
exercising permissions granted by this License. | ||
|
||
"Source" form shall mean the preferred form for making modifications, | ||
including but not limited to software source code, documentation | ||
source, and configuration files. | ||
|
||
"Object" form shall mean any form resulting from mechanical | ||
transformation or translation of a Source form, including but | ||
not limited to compiled object code, generated documentation, | ||
and conversions to other media types. | ||
|
||
"Work" shall mean the work of authorship, whether in Source or | ||
Object form, made available under the License, as indicated by a | ||
copyright notice that is included in or attached to the work | ||
(an example is provided in the Appendix below). | ||
|
||
"Derivative Works" shall mean any work, whether in Source or Object | ||
form, that is based on (or derived from) the Work and for which the | ||
editorial revisions, annotations, elaborations, or other modifications | ||
represent, as a whole, an original work of authorship. For the purposes | ||
of this License, Derivative Works shall not include works that remain | ||
separable from, or merely link (or bind by name) to the interfaces of, | ||
the Work and Derivative Works thereof. | ||
|
||
"Contribution" shall mean any work of authorship, including | ||
the original version of the Work and any modifications or additions | ||
to that Work or Derivative Works thereof, that is intentionally | ||
submitted to Licensor for inclusion in the Work by the copyright owner | ||
or by an individual or Legal Entity authorized to submit on behalf of | ||
the copyright owner. For the purposes of this definition, "submitted" | ||
means any form of electronic, verbal, or written communication sent | ||
to the Licensor or its representatives, including but not limited to | ||
communication on electronic mailing lists, source code control systems, | ||
and issue tracking systems that are managed by, or on behalf of, the | ||
Licensor for the purpose of discussing and improving the Work, but | ||
excluding communication that is conspicuously marked or otherwise | ||
designated in writing by the copyright owner as "Not a Contribution." | ||
|
||
"Contributor" shall mean Licensor and any individual or Legal Entity | ||
on behalf of whom a Contribution has been received by Licensor and | ||
subsequently incorporated within the Work. | ||
|
||
2. Grant of Copyright License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
copyright license to reproduce, prepare Derivative Works of, | ||
publicly display, publicly perform, sublicense, and distribute the | ||
Work and such Derivative Works in Source or Object form. | ||
|
||
3. Grant of Patent License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
(except as stated in this section) patent license to make, have made, | ||
use, offer to sell, sell, import, and otherwise transfer the Work, | ||
where such license applies only to those patent claims licensable | ||
by such Contributor that are necessarily infringed by their | ||
Contribution(s) alone or by combination of their Contribution(s) | ||
with the Work to which such Contribution(s) was submitted. If You | ||
institute patent litigation against any entity (including a | ||
cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
or a Contribution incorporated within the Work constitutes direct | ||
or contributory patent infringement, then any patent licenses | ||
granted to You under this License for that Work shall terminate | ||
as of the date such litigation is filed. | ||
|
||
4. Redistribution. You may reproduce and distribute copies of the | ||
Work or Derivative Works thereof in any medium, with or without | ||
modifications, and in Source or Object form, provided that You | ||
meet the following conditions: | ||
|
||
(a) You must give any other recipients of the Work or | ||
Derivative Works a copy of this License; and | ||
|
||
(b) You must cause any modified files to carry prominent notices | ||
stating that You changed the files; and | ||
|
||
(c) You must retain, in the Source form of any Derivative Works | ||
that You distribute, all copyright, patent, trademark, and | ||
attribution notices from the Source form of the Work, | ||
excluding those notices that do not pertain to any part of | ||
the Derivative Works; and | ||
|
||
(d) If the Work includes a "NOTICE" text file as part of its | ||
distribution, then any Derivative Works that You distribute must | ||
include a readable copy of the attribution notices contained | ||
within such NOTICE file, excluding those notices that do not | ||
pertain to any part of the Derivative Works, in at least one | ||
of the following places: within a NOTICE text file distributed | ||
as part of the Derivative Works; within the Source form or | ||
documentation, if provided along with the Derivative Works; or, | ||
within a display generated by the Derivative Works, if and | ||
wherever such third-party notices normally appear. The contents | ||
of the NOTICE file are for informational purposes only and | ||
do not modify the License. You may add Your own attribution | ||
notices within Derivative Works that You distribute, alongside | ||
or as an addendum to the NOTICE text from the Work, provided | ||
that such additional attribution notices cannot be construed | ||
as modifying the License. | ||
|
||
You may add Your own copyright statement to Your modifications and | ||
may provide additional or different license terms and conditions | ||
for use, reproduction, or distribution of Your modifications, or | ||
for any such Derivative Works as a whole, provided Your use, | ||
reproduction, and distribution of the Work otherwise complies with | ||
the conditions stated in this License. | ||
|
||
5. Submission of Contributions. Unless You explicitly state otherwise, | ||
any Contribution intentionally submitted for inclusion in the Work | ||
by You to the Licensor shall be under the terms and conditions of | ||
this License, without any additional terms or conditions. | ||
Notwithstanding the above, nothing herein shall supersede or modify | ||
the terms of any separate license agreement you may have executed | ||
with Licensor regarding such Contributions. | ||
|
||
6. Trademarks. This License does not grant permission to use the trade | ||
names, trademarks, service marks, or product names of the Licensor, | ||
except as required for reasonable and customary use in describing the | ||
origin of the Work and reproducing the content of the NOTICE file. | ||
|
||
7. Disclaimer of Warranty. Unless required by applicable law or | ||
agreed to in writing, Licensor provides the Work (and each | ||
Contributor provides its Contributions) on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
implied, including, without limitation, any warranties or conditions | ||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
PARTICULAR PURPOSE. You are solely responsible for determining the | ||
appropriateness of using or redistributing the Work and assume any | ||
risks associated with Your exercise of permissions under this License. | ||
|
||
8. Limitation of Liability. In no event and under no legal theory, | ||
whether in tort (including negligence), contract, or otherwise, | ||
unless required by applicable law (such as deliberate and grossly | ||
negligent acts) or agreed to in writing, shall any Contributor be | ||
liable to You for damages, including any direct, indirect, special, | ||
incidental, or consequential damages of any character arising as a | ||
result of this License or out of the use or inability to use the | ||
Work (including but not limited to damages for loss of goodwill, | ||
work stoppage, computer failure or malfunction, or any and all | ||
other commercial damages or losses), even if such Contributor | ||
has been advised of the possibility of such damages. | ||
|
||
9. Accepting Warranty or Additional Liability. While redistributing | ||
the Work or Derivative Works thereof, You may choose to offer, | ||
and charge a fee for, acceptance of support, warranty, indemnity, | ||
or other liability obligations and/or rights consistent with this | ||
License. However, in accepting such obligations, You may act only | ||
on Your own behalf and on Your sole responsibility, not on behalf | ||
of any other Contributor, and only if You agree to indemnify, | ||
defend, and hold each Contributor harmless for any liability | ||
incurred by, or claims asserted against, such Contributor by reason | ||
of your accepting any such warranty or additional liability. | ||
|
||
END OF TERMS AND CONDITIONS | ||
|
||
APPENDIX: How to apply the Apache License to your work. | ||
|
||
To apply the Apache License to your work, attach the following | ||
boilerplate notice, with the fields enclosed by brackets "{}" | ||
replaced with your own identifying information. (Don't include | ||
the brackets!) The text should be enclosed in the appropriate | ||
comment syntax for the file format. We also recommend that a | ||
file or class name and description of purpose be included on the | ||
same "printed page" as the copyright notice for easier | ||
identification within third-party archives. | ||
|
||
Copyright {yyyy} {name of copyright owner} | ||
|
||
Licensed 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
gödel | ||
===== | ||
gödel is a Go build tool that provides tasks for configuring, formatting, checking, testing, building and publishing Go | ||
projects in a declarative, consistent and reproducible manner across different platforms and environments. gödel can be | ||
used in both local development environments and for verifying the correctness of project in CI environments. gödel uses | ||
declarative configuration to define the parameters for a project and provides an executable that orchestrates build | ||
tasks using standard Go commands. It centralizes project configuration and eliminates the need for custom build scripts | ||
that conflate configuration with logic. gödel is designed to be portable, fast and lightweight -- adding it to a project | ||
consists of copying a single file and directory into the project and adds less than 50kb of version-controlled material. | ||
|
||
Features | ||
-------- | ||
* Add to a project by copying the `godelw` script and the `godel` configuration directory into a project | ||
* `./godelw git-hooks` installs Git commit hook that formats files on commit | ||
* `./godelw idea` creates and configures an IntelliJ IDEA project for the project | ||
* Supports configuring directories and files that should be excluded by the tool (vendor directory is excluded by default) | ||
* `./godelw format` formats all code in a project | ||
* `./godelw check` runs a variety of code linting checks on all the code in a project | ||
* `./godelw license` applies a specified license header to all Go files in a project | ||
* Supports configuring custom license headers for specific directories or files | ||
* `./godelw test` runs the tests in the project | ||
* Configuration can be used to define test sets (such as integration tests) and run specific test sets | ||
* Supports outputting the test results in a JUnit XML format | ||
* `./godelw build` builds executables for `main` packages in the project | ||
* Supports cross-platform compilation | ||
* Supports configuration of `ldflag` for version and other variables | ||
* Installs packages by default to speed up repeated builds | ||
* `./godelw dist` creates distribution files for products | ||
* Supports creating `tgz` and `rpm` distributions | ||
* Supports customizing creation of distribution using scripts | ||
* `./godelw publish` publishes artifacts to Bintray or Artifactory | ||
* `palantir/godel/pkg/products` package provides a mechanism to easily write integration tests for gödel projects | ||
* Provides a function that builds the product executable or distribution and provides a path to invoke it | ||
* `./godelw update` updates gödel to the version specified in `godel/config/godel.properties` | ||
* `./godelw github-wiki` mirrors a documents directory to a GitHub Wiki repository | ||
* `./godelw verify` runs the `format`, `import`, `license`, `check` and `test` tasks | ||
* Can be used locally as a single command to apply changes and run checks | ||
* Can be used in CI to verify that a project is in the proper state without applying changes | ||
|
||
This list is not exhaustive -- run `./godelw --help` for a list of all of the available commands. | ||
|
||
Documentation | ||
------------- | ||
Documentation for this project is in the `docs` directory and the [GitHub Wiki](https://github.com/palantir/godel/wiki) | ||
(the GitHub Wiki mirrors the contents of the `docs` directory). | ||
|
||
Development | ||
----------- | ||
The code for the tasks provided by gödel is in the `cmd` directory. gödel tasks fall into 2 categories: those whose | ||
functionality are implemented directly in gödel packages and those whose functionality is implemented by a sub-program | ||
that exposes its tasks as library functions that are directly callable. | ||
|
||
The `app.go` file in the top-level `godel` package registers the top-level tasks available in the CLI. It registers the | ||
tasks whose functionality is implemented directly in gödel directly. The tasks provided by sub-programs are defined in | ||
`cmd/clicmds/cfgcli.go`. | ||
|
||
After making changes to the code, run `./godelw verify` to format the code, apply the proper license headers, update | ||
dependency information, run code linting checks and all unit tests. | ||
|
||
gödel also defines integration tests in the `test/integration` directory. The tests in this file create a distribution | ||
of gödel and run tests against it. Run `./godelw test --tags=integration` to run the integration tests (the integration | ||
tests are not run by `./godelw verify` or `./godelw test` by default). | ||
|
||
### Sub-applications in the apps directory | ||
The functionality for some gödel tasks are provided by sub-applications. `distgo`, `gonform`, `gunit` and `okgo` are | ||
such sub-applications and are located in the `apps` directory. These sub-applications can be compiled and run as self- | ||
contained CLI applications, but also expose functionality as libraries. | ||
|
||
Changes that are made in these sub-applications directly impact gödel, and many of the gödel integration tests test the | ||
functionality provided by these sub-applications. The sub-applications also have their own set of tests. Each of the | ||
sub-applications in the `apps` directory have their own test suite that is the name of the sub-application and can be | ||
invoked using its tag -- for example, to run the tests for `distgo`, run `./godelw test --tags=distgo`. | ||
|
||
Refer to the README files in the sub-applications for more information on application-specific development. | ||
|
||
### Sub-applications outside of the repository | ||
Some tasks such as `imports` and `license` use sub-applications that are defined outside of the repository (in this | ||
case, `gocd` and `golicense`, respectively) and vendor the sub-applications to use their functionality. Changing these | ||
tasks is akin to changing a vendored library -- locate the original repository for the library, make changes there and | ||
then update the vendored library in gödel. | ||
|
||
License | ||
------- | ||
This project is made available under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
// Copyright 2016 Palantir Technologies, Inc. | ||
// | ||
// Licensed 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. | ||
|
||
package godel | ||
|
||
import ( | ||
"github.com/nmiyake/pkg/errorstringer" | ||
"github.com/palantir/pkg/cli" | ||
|
||
"github.com/palantir/godel/cmd" | ||
"github.com/palantir/godel/cmd/checkpath" | ||
"github.com/palantir/godel/cmd/clicmds" | ||
"github.com/palantir/godel/cmd/githooks" | ||
"github.com/palantir/godel/cmd/githubwiki" | ||
"github.com/palantir/godel/cmd/godel" | ||
"github.com/palantir/godel/cmd/idea" | ||
"github.com/palantir/godel/cmd/packages" | ||
"github.com/palantir/godel/cmd/verify" | ||
) | ||
|
||
func App(gödelPath string) *cli.App { | ||
app := cli.NewApp(cli.DebugHandler(errorstringer.StackWithInterleavedMessages)) | ||
app.Name = "godel" | ||
app.Usage = "Run tasks for coding, checking, formatting, testing, building and publishing Go code" | ||
app.Flags = append(app.Flags, cmd.GlobalCLIFlags()...) | ||
app.Version = godel.Version | ||
|
||
app.Subcommands = []cli.Command{ | ||
godel.VersionCommand(), | ||
godel.InstallCommand(), | ||
godel.UpdateCommand(), | ||
checkpath.Command(), | ||
githooks.Command(), | ||
githubwiki.Command(), | ||
idea.Command(), | ||
packages.Command(), | ||
verify.Command(gödelPath), | ||
} | ||
app.Subcommands = append(app.Subcommands, clicmds.CfgCliCommands(gödelPath)...) | ||
|
||
return app | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
/build | ||
/dist |
Oops, something went wrong.