pycharm-formula
Formula to install Pycharm on Windows (interactive), GNU/Linux, and MacOS.
1. General notes
See the full SaltStack Formulas installation and usage instructions.
If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.
If you want to use this formula, please pay attention to the FORMULA
file and/or git tag, which contains the currently released version.
This formula is versioned according to Semantic
Versioning.
See Formula Versioning Section for more details.
If you need (non-default) configuration, please pay attention to the
pillar.example file and/or Special notes section.
2. Contributing to this repo
Commit message formatting is significant!!
Please see How to contribute for more details.
4. Available states
4.1. pycharm
Meta-state (This is a state that includes other states).
This installs Pycharm package, manages Pycharm configuration file and then configures the development environment.
4.4. pycharm.config
This state will configure npmrc and/or environment and has a dependency
on pycharm.install via include list.
4.6. pycharm.clean
Meta-state (This is a state that includes other states).
this state will undo everything performed in the pycharm meta-state in
reverse order, i.e. removes the configuration file and then uninstalls
the package.
4.7. pycharm.config.clean
This state will remove the configuration of Pycharm and has a dependency
on pycharm.package.clean via include list.
4.8. pycharm.archive.clean
This state will remove Pycharm package and has a dependency on
pycharm.config.clean via include list.
5. Testing
Linux testing is done with kitchen-salt.
5.1. Requirements
-
Ruby
-
Docker
$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]Where [platform] is the platform name defined in kitchen.yml, e.g.
debian-9-2019-2-py3.
5.2. bin/kitchen converge
Creates the docker instance and runs the pycharm main state, ready for
testing.