add packaging guide #12
Conversation
tomerd
requested review from
loganwright,
tanner0101,
weissi,
drexin,
ktoso and
yim-lee
motivation: provide guidance around how an aplication can be packaged for deployments changes: add packaging.md wih instructions for docker, tarball and source distributions
Co-authored-by: Yim Lee <yim_lee@apple.com>
| # Packaging Applications for Deployment | ||
|
|
||
| Once an application is built for production, it still needs to be packaged before it can be deployed to servers. There are several strategies for packaging Swift applications for deployment. | ||
|
|
There was a problem hiding this comment.
Open question about how to host those guides really... Are we intending to keep those guides as md files, or is this until we have a better place for them?
Normally it'd be nice to have a ToC here so one can skim what options there are and jump to one, rather than scroll the document IMO. It'd be a bit nicer if those are to be official guides if we could present them "well" 🤔
Just a thought, back to reviewing the content
There was a problem hiding this comment.
good point @ktoso, once we have enough content I think some of these will go into swift.org.
There was a problem hiding this comment.
Excellent! Let's stick to simple .md until then, then 👍
| To test the local image use the `docker run` command, .e.g.: | ||
|
|
||
| ```bash | ||
| $ docker run <my-app>:<my-app-version> |
There was a problem hiding this comment.
May I suggest that we amend a bit the style we do code snippets with user filled in things a bit?
It's nice if before we start there's a
export MY_APP=<my-app>
export MY_APP_VERSION=<...>
and then in all snippets we use those; this allows people to set their values and copy paste the steps if they want to.
(as silly as it is to encourage copy paste i think it helps some folks and eases the barrier to try things out).
Just an idea
Co-authored-by: Yim Lee <yim_lee@apple.com> Co-authored-by: Konrad `ktoso` Malawski <konrad.malawski@project13.pl>
|
/cc @swift-server/sswg |
Co-authored-by: Johannes Weiss <johannesweiss@apple.com>
| -v "$PWD:/workspace" \ | ||
| -w /workspace \ | ||
| swift:5.2-bionic \ | ||
| /bin/bash -cl "swift build -c release" |
There was a problem hiding this comment.
| /bin/bash -cl "swift build -c release" | |
| /bin/bash -xcl "swift -version && swift build -c release" |
feel free to ignore but I prefer to always see the version number as that's often important.
There was a problem hiding this comment.
I also like -x because it prints all the random env variables that may be important when debugging stuff (but it does make the output a little bit uglier ofc)
There was a problem hiding this comment.
sample output:
$ jw-docker-swift-5.2 /bin/bash -xcl "swift -version && swift build -c release"
+ '[' '' ']'
+ '[' -d /etc/profile.d ']'
+ for i in /etc/profile.d/*.sh
+ '[' -r /etc/profile.d/01-locale-fix.sh ']'
+ . /etc/profile.d/01-locale-fix.sh
+++ /usr/bin/locale-check C.UTF-8
++ eval
+ unset i
+ '[' /bin/bash ']'
+ '[' -f /root/.bashrc ']'
+ . /root/.bashrc
++ '[' -z '' ']'
++ return
+ mesg n
+ true
+ swift -version
Swift version 5.2.3 (swift-5.2.3-RELEASE)
Target: x86_64-unknown-linux-gnu
+ swift build -c release
[39/39] Linking NIOPerformanceTester
motivation: provide guidance around how an aplication can be packaged for deployments
changes: add packaging.md wih instructions for docker, tarball and source distributions