cyberark / community Goto Github PK
View Code? Open in Web Editor NEWInformation for the CyberArk contributor community
License: Apache License 2.0
Information for the CyberArk contributor community
License: Apache License 2.0
The template repository should include:
README.md
with instructions on getting started (that are deleted on copying)LICENSE
CONTRIBUTING.md
Jenkinsfile
Standard issue templates have been added to all public repositories
AC:
Add daily build triggers to the Jenkinsfile for any repos in this list that have pipelines but don't already have it turned on:
Daily pipeline builds can be turned on by adding
triggers {
cron(getDailyCronString())
}
to the Jenkinsfile
Each public repository should include an open source acknowledgements file that is kept up-to-date with the OSS dependencies in the project
AC:
cyberark
GitHub org, and links to READMEs in separate folders for those three groups. There should be a bullet for each group that is involved - CyberArk Labs, CyberArk Conjur, and CyberArk Cloud Solutions - and the bullets should each link to a README in a folder for each group (eg labs
, conjur
, and cloud
).Once this is merged and live in the repo, we'll ask PMM for feedback on the main community README, and alert the cloud and lab teams to let them know to add content to their folders
We may need to define this process for the OSS community first. Suggested flow:
AC:
There is an initial OSS suite release with:
AC:
The following templates have been added to the repo, with appropriate component
labels:
We'd love to have a future contributor look through the community repo and give us feedback on what could be clearer and how we can improve it.
TBD - depends on whether the github landing page is live. If so, we can advise to find the appropriate repository's issue page and click "new issue". Otherwise we may need to come up with more generic guidelines.
All public repos have bug and feature request issue templates.
Suggested templates:
Repos:
AC:
recreateConnections=false
(aka persistent connection) performance tests have been run for MSSQL in a realistic environment (eg the XA env)@diverdane recently did a POC of revising the [Secretless demo](https://github.com/cyberark/secretless-broker/tree/master/demos/k8s-demo/] to run using KinD: https://github.com/diverdane/secretless-k8s-demo
This would make an interesting blog post. Some points to consider hitting:
AC:
The broken terraform provider build here needs to be fixed.
As a | Conjur Open Source user |
I want | to know what tools and integrations there are for Conjur |
so that | I can evaluate whether Conjur is suitable for me to use, and which tools / integrations are compatible with my systems. |
As a | Conjur Open Source user |
I want | to know what versions of Conjur OSS components to use |
so that | I am using reliable, well-tested software that works together as expected when used within my systems. |
As a | maintainer of a Conjur OSS suite component |
I want | to know how to ensure new versions of my component get into the OSS suite release |
so that | OSS users can benefit from new features my team is adding to our component. |
As a | maintainer of a Conjur OSS suite component |
I want | to know what I'm responsible for testing and what will be tested in the OSS suite |
so that | it's clear what tests I need to include and maintain in my component repository, and which tests belong in the central OSS suite release repo. |
As a | maintainer of a Conjur OSS suite component |
I want | to know what standards I need to maintain in my repository |
so that | my CHANGELOG entries, releases, READMEs, etc are compatible with the OSS suite release. |
As a | Conjur Open Source contributor |
I want | to know what components there are |
so that | I can find components that I can contribute to. |
As a | Conjur Open Source contributor |
I want | to know what is included in the Conjur OSS suite |
so that | if there are tools or platforms that are not supported, I can make a difference by building something to fill the gap. |
As a | Conjur release manager |
I want | o know what changes have been made to components since the last suite release |
so that | I can decide if enough changes have been made to merit a new release. |
As a | Conjur release manager |
I want | to know how to create a new release, including any manual steps that are required |
so that | I can successfully create a new release without missing any steps. |
As a | Conjur release manager |
I want | to know the results of automated tests |
so that | I can be sure all included components work together as expecteed at the pinned versions. |
As a | developer on a downstream project that uses Conjur as its core |
I want | to know when there are new Conjur OSS suite releases |
so that | I can review the changes and update my project to use the latest OSS suite release version of Conjur. |
As a | developer on a downstream project that uses Conjur as its core |
I want | a machine readable summary of what is included in each OSS suite release |
so that | I can build automation around the OSS suite releases as needed. |
In cyberark/conjur#1261 it was noted that the Conjur github repo still links to Slack in its README.
Our other public repos need to also be reviewed to ensure that they do not also link to Slack - if they do, they should be updated to refer to CyberArk Commons instead.
Our public repositories should clearly document what process non-employees should do to report potential security bugs. This could involve:
In this effort, we will define the standard way Conjur Open Source repos should document security vulnerabilities, and we will update the current set of public non-archived repositories to follow this process.
AC:
The copyrights on our license files in all Conjur-owned repos are updated to
Copyright (c) 2020 CyberArk Software Ltd. All rights reserved.
Given a project that is written in Go and uses Go modules for package management
Then an acknowledgements file (NOTICES.txt) can automatically be created from the go.mod
And when the go.mod is updated
Then the pipeline can auto-detect an update to the acknowledgements is needed
And there is a script to auto-update the acknowledgements file given the new go.mod
Potential tools to leverage to automate this:
Improve the workflow to make "in progress" and "merged but not released" issues more visibile in GitHub / to people without ZenHub access
The top-level README.md in the community repo should give a clear and detailed introduction to each team (Conjur, Cloud Solutions, Labs, etc.)
AC:
Note: as you're adding new contributing files please be sure to update the README to link to the project CONTRIBUTING, and move all contributor focused content from the README to the project CONTRIBUTING.
This means that PRs where you add CONTRIBUTING.md should change two files - CONTRIBUTING and the README. Repos where you update the existing contributing to link to the generic guidelines will just change one file.
The following projects should be updated to have the same pull request template as the one used in Conjur, here: https://github.com/cyberark/conjur/blob/master/.github/PULL_REQUEST_TEMPLATE.md.
These repos already have a pull request template, please review them and determine whether they can be updated to a format like the Conjur template, or if they need to remain as-is:
NewConnectionDetails has support for SSLOptions, similar to the PG and MySQL adapter.
GIVEN I am the OSS suite release manager
AND I know what is available to release
AND I have determined what I want to include in the next OSS suite release
AND I know the version of the next OSS suite release
THEN I know the process for creating a new OSS suite release
AND I can follow that process to create a new OSS suite release
AC:
wrong place
AC:
AC:
The current Conjur Puppet page lists Zendesk for support (see the support section
The page needs to be updated with current contact information for Conjur support, i.e. the Conjur channel in Discourse here or this github repo's issues section.
Using a documented manual but repeatable process, metrics are collected on the following:
Aha card: https://cyberark.aha.io/features/AAM-264
The basis for the proposal includes the following:
The goal is to define maturity levels for contributions so that we can enable community contributions while continuing to be clear to end users about expected maturity of features in the open source suite of products.
AC:
This is a follow-up to #26, which (oops) did not include all relevant repos.
Suggested templates:
AC: Add or update feature request and bug templates in the following repos:
Add a header to the top of all source code files (e.g. .go
and .rb
files, etc) with:
// Copyright (c) 2020 CyberArk Software Ltd. All rights reserved.
// Use of this source code is governed by an Apache 2.0
// license that can be found in the LICENSE file.
The following repos should have a CODEOWNERS file in .github/CODEOWNERS
that includes the single line:
* @cyberark/community-and-integrations-team
AC:
In the Conjur folder, there needs to be:
about-X
channels in SlackAs with every project, the community repo is open to contributions from the external and internal community.
We verify that connection succeeds with simple queries when connecting to Secretless through JDBC
The jdbc jar in /tests/util/jdbc
currently sits around 4.3 MB, and it would be better practice if we built it for our tests instead of storing the binary in our repository. There are several ways we could approach this, and several steps.
The Golang Style guide is missing a few categories that are relevant to the work of the Conjur team projects.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.