Skip to content
Make remote development work with your local tools
Go Other
  1. Go 99.3%
  2. Other 0.7%
Branch: master
Clone or download
havoc-io Added version support policy
This commit adds a better-defined version support policy to the
README.md file. This policy is motivated by the need to avoid breakage
for developers across large releases. This policy may evolve as new
situations are encountered, but it's a suitable baseline.

Fixes #122.

Signed-off-by: Jacob Howard <jacob@havoc.io>
Latest commit cd6f4e1 Jul 31, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmd Cleaned up listing to be slightly more user-friendly Jul 28, 2019
pkg Bumped version to v0.11.0-dev. Jul 23, 2019
scripts Added remote development environment and project definition for Mutagen Jul 23, 2019
.codecov.yaml Added codecov.io YAML configuration to ignore generated code. Oct 27, 2017
.gitattributes Added .gitattributes file. Nov 3, 2016
.gitignore Added build directory to .gitignore. Jul 15, 2019
.travis.yml Consolidated continuous integration scripts Jul 23, 2019
BUILDING.md Updated project ownership URLs and domains. Jul 15, 2019
CONTRIBUTING.md Fixed a few incorrect links and typos in CONTRIBUTING.md Jul 16, 2019
DCO Updated README and contributing guidelines, adopted DCO Jul 16, 2019
LICENSE Updated copyright holder. Jul 15, 2019
README.md Added version support policy Jul 31, 2019
SECURITY.md Updated project ownership URLs and domains. Jul 15, 2019
appveyor.yml Consolidated continuous integration scripts Jul 23, 2019
docker-compose.yml Added remote development environment and project definition for Mutagen Jul 23, 2019
go.mod Updated module path to new location. Jul 15, 2019
go.sum
mutagen.yml Added remote development environment and project definition for Mutagen Jul 23, 2019

README.md

Mutagen

Mutagen is a new kind of remote development tool that enables your existing local tools to work with code in remote environments like cloud servers and containers. It does this by providing high-performance real-time file synchronization and flexible network forwarding. Support is currently implemented for synchronization and forwarding between local systems, SSH-accessible locations, and Docker containers, with more on the way!

Getting started

The best way to understand Mutagen and its features is to read the Overview and Getting started guides. You can find information about all of Mutagen's features in the documentation.

Installation

You can find installation instructions in the Mutagen documentation.

Community

Mutagen's community chat is the place to go for discussion, questions, and ideas:

Join the community on Spectrum

For updates about the project and its releases, you can:

Status

Mutagen is built and tested on Windows, macOS, and Linux, and it's available for many more platforms.

Windows macOS/Linux Code coverage Report card License
Windows macOS/Linux Code coverage Report card License

Contributing

If you'd like to contribute to Mutagen, please see the contribution documentation.

External projects

Users have built a number of cool projects to extend and integrate Mutagen into their workflows:

  • Mutagen Helper is a tool that makes the orchestration of synchronization sessions even easier by letting you define sessions with configuration files that live inside your codebase. Thanks to @Toilal!
  • docker-magento-mutagen (from Mage2click) is a Docker-based development environment for Magento that uses Mutagen for file synchronization. Thanks to @u-maxx and @shkoliar.

Security

Mutagen takes security very seriously. If you believe you have found a security issue with Mutagen, please practice responsible disclosure practices and send an email directly to security@mutagen.io instead of opening a GitHub issue. For more information, please see the security documentation.

Versioning and support

Mutagen uses semantic versioning for tracking releases. Each minor release series is supported for the release cycle of the next minor release series or for 3 months, whichever is longer.

The builds for each minor release series are pinned to the same Go minor release and dependency versions used for developing that series (though patch releases will be incorporated if they contain security fixes).

We reserve the right to break or bend these rules if necessary for the sake of security, e.g. discontinuing support for a minor release to which a security fix cannot be backported or upgrading Go minor versions for a release series to incorporate important security fixes.

Building

Please see the build instructions.

You can’t perform that action at this time.